module HelloSign::Api::SignatureRequest

Contains all the API calls for the SignatureRequest resource. Take a look at our API Documentation on Signature Requests (app.hellosign.com/api/reference#SignatureRequest) for more information about this.

@author [hellosign]

Public Instance Methods

bulk_send_with_template(opts) click to toggle source

Creates a BulkSendJob based off of the Template specified with the template_id parameter. @option opts [Boolean] test_mode Indicates if this is a test BulkSendJob, its SignatureRequests will not be legally binding if set to 1. 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 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 [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (optional) @option opts [String] signer_file Uploads a CSV file defining values and options for signer fields. Required if signer_list is not used. @option opts [String] signer_list A JSON array defining values and options for signer fields. Required if signer_file is not used. @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on 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 [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 [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)

@return [HelloSign::Resource::BulkSendJob] a BulkSendJob

@example

signature_request = @client.bulk_send_with_template(
  test_mode: 1,
  allow_decline: 0,
  template_id: 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
  title: 'Purchase Order',
  subject: 'Purchase Order',
  message: 'Glad we could come to an agreement.',
  metadata: {
    client_id: '1234',
    custom_text: 'NDA #9'
  },
  signer_list: [
    {
      signers: {
        Client: {
          name: 'George',
          email_address: 'bulksend1@example.com'
        }
      },
      custom_fields: {
        address: '100 Grand'
      }
    },
    {
      signers: {
        Client: {
          name: 'Mary',
          email_address: 'bulksend2@example.com'
        }
      }
    }
  ],
  ccs: [
    {
     email_address: 'accounting@example.com',
     role: 'Accounting'
    }
  ]
)
# File lib/hello_sign/api/signature_request.rb, line 322
def bulk_send_with_template(opts)
  prepare_bulk_signers opts
  prepare_ccs opts
  prepare_templates opts
  prepare_custom_fields opts

  HelloSign::Resource::BulkSendJob.new post('/signature_request/bulk_send_with_template', body: opts)
end
cancel_signature_request(opts) click to toggle source

Cancels an incomplete SignatureRequest. @option opts [String] signature_request_id The ID of SignatureRequest to cancel.

@return [HTTP::Status] 200 OK

@example

@client.cancel_signature_request signature_request_id: '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
# File lib/hello_sign/api/signature_request.rb, line 428
def cancel_signature_request(opts)
  post("/signature_request/cancel/#{opts[:signature_request_id]}", body: opts)
end
create_embedded_signature_request(opts) click to toggle source

Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified or use_text_tags is not enabled, a signature page will be affixed at the end. See our Embedded Signing Walkthrough for more information on Embedded Signing: 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. Defaults to 0. (optional) @option opts [String] client_id The API App Client ID associated with 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 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 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)
* pin (Integer) Secures the SignatureRequest using this 4-12 character access code. A business plan is required to use this feature. (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.
* 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) @option opts [Hash] signing_options Specifies the types allowed for creating a signature. (optional)

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example

request = @client.create_embedded_signature_request(
  test_mode: 1,
  allow_decline: 1,
  client_id: 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
  title: 'NDA with Acme Co.',
  subject: 'The NDA we talked about',
  message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
  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'
  }
)
# File lib/hello_sign/api/signature_request.rb, line 552
def create_embedded_signature_request(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::SignatureRequest.new post('/signature_request/create_embedded', body: opts)
end
create_embedded_signature_request_with_template(opts) click to toggle source

Creates a new SignatureRequest based on the given Template to be signed in an embedded iFrame. See our Embedded Signing Walkthrough for more information on Embedded Signing: 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. Defaults to 0. (optional) @option opts [String] client_id The API App Client ID associated with 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 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 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)
* pin (Integer) Secures the SignatureRequest using this 4-12 character access code. A business plan is required 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) @option opts [Hash] signing_options Specifies the types allowed for creating a signature. (optional)

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example

request = @client.create_embedded_signature_request_with_template(
  test_mode: 1,
  allow_decline: 1,
  client_id: 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
  template_id: 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
  title: 'Purchase Order',
  subject: 'Purchase Order',
  message: 'Glad we could come to an agreement.',
  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'
 }
)
# File lib/hello_sign/api/signature_request.rb, line 631
def create_embedded_signature_request_with_template(opts)
  opts[:client_id] ||= self.client_id
  prepare_signers opts
  prepare_ccs opts
  prepare_templates opts
  prepare_custom_fields opts
  prepare_files opts

  HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded_with_template', body: opts)
end
embedded_bulk_send_with_template(opts) click to toggle source

Creates an embedded BulkSendJob based off of the Template specified with the template_id parameter. @option opts [Boolean] test_mode Indicates if this is a test BulkSendJob, its SignatureRequests will not be legally binding if set to 1. 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] client_id The API App Client ID associated with this embedded BulkSendJob. @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 [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (optional) @option opts [String] signer_file Uploads a CSV file defining values and options for signer fields. Required if signer_list is not used. @option opts [String] signer_list A JSON array defining values and options for signer fields. Required if signer_file is not used. @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on 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 [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 [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)

@return [HelloSign::Resource::BulkSendJob] a BulkSendJob

@example

signature_request = @client.embedded_bulk_send_with_template(
  test_mode: 1,
  allow_decline: 0,
  template_id: 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
  client_id: 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
  title: 'Purchase Order',
  subject: 'Purchase Order',
  message: 'Glad we could come to an agreement.',
  metadata: {
    client_id: '1234',
    custom_text: 'NDA #9'
  },
  signer_list: [
    {
      signers: {
        Client: {
          name: 'George',
          email_address: 'bulksend1@example.com'
        }
      },
      custom_fields: {
        address: '100 Grand'
      }
    },
    {
      signers: {
        Client: {
          name: 'Mary',
          email_address: 'bulksend2@example.com'
        }
      }
    }
  ],
  ccs: [
    {
     email_address: 'accounting@example.com',
     role: 'Accounting'
    }
  ]
)
# File lib/hello_sign/api/signature_request.rb, line 396
def embedded_bulk_send_with_template(opts)
  prepare_bulk_signers opts
  prepare_ccs opts
  prepare_templates opts
  prepare_custom_fields opts

  HelloSign::Resource::BulkSendJob.new post('/signature_request/bulk_create_embedded_with_template', body: opts)
end
get_signature_request(opts) click to toggle source

Retrieves a SignatureRequest with the given ID. @option opts [String] signature_request_id The ID of the SignatureRequest to retrieve.

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example signature_request = @client.get_signature_request signature_request_id: 'fa5c8a0b0f492d768749333ad6fcc214c111e967'

# File lib/hello_sign/api/signature_request.rb, line 40
def get_signature_request(opts)
  path = "/signature_request/#{opts[:signature_request_id]}"

  HelloSign::Resource::SignatureRequest.new get(path)
end
get_signature_requests(opts={}) click to toggle source

Returns a list of send and received SignatureRequests that you can access. This does not include 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 Filters the SignatureRequests based on the search parameters. (optional)

@return [HelloSign::Resource::ResourceArray]

@example signature_requests = @client.get_signature_requests(

page: 1,
query: "to:jack@example.com+AND+client_id:b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"

)

# File lib/hello_sign/api/signature_request.rb, line 59
def get_signature_requests(opts={})
  path = '/signature_request/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), 'signature_requests', HelloSign::Resource::SignatureRequest
end
remind_signature_request(opts) click to toggle source

Sends an email reminder to the signer about the SignatureRequest. @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

signature_request = @client.remind_signature_request(
  signature_request_id: '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
  :email_address: 'john@example.com'
)
# File lib/hello_sign/api/signature_request.rb, line 417
def remind_signature_request(opts)
  HelloSign::Resource::SignatureRequest.new post("/signature_request/remind/#{opts[:signature_request_id]}", body: opts)
end
remove_signature_request(opts) click to toggle source

Removes your access to a completed a SignatureRequest. @option opts [String] signature_request_id The ID of the completed SignatureRequest to remove access.

@return [HTTP::Status] 200 OK

@example

@client.remove_signature_request signature_request_id: '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
# File lib/hello_sign/api/signature_request.rb, line 439
def remove_signature_request(opts)
  post("/signature_request/remove/#{opts[:signature_request_id]}", body: opts)
end
send_signature_request(opts) click to toggle source

Creates and sends a new SignatureRequest with the submitted documents. @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] 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 [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (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)
* pin (Integer) Secures the SignatureRequest using this 4-12 character access code. A business plan is required to use this feature. (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.
* 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) @option opts [Hash] signing_options Specifies the types allowed for creating a signature. (optional)

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example

signature_request = @client.send_signature_request(
  test_mode: 1,
  allow_decline: 1,
  title: 'NDA with Acme Co.',
  subject: 'The NDA we talked about',
  message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
  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'],
  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
         }
     ]
   ],
  signing_options: {
    draw: true,
    type: true,
    upload: false,
    phone: true,
    default: 'phone'
    }
  )
# File lib/hello_sign/api/signature_request.rb, line 170
def send_signature_request(opts)
  prepare_files opts
  prepare_signers opts
  prepare_form_fields opts
  prepare_custom_fields opts
  prepare_attachments opts

  request = HelloSign::Resource::SignatureRequest.new post('/signature_request/send', body: opts)
end
send_signature_request_with_template(opts) click to toggle source

Creates and sends a new SignatureRequest based off of the Template specified with the template_id parameter. @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 [Boolean] allow_decline Allows signers to decline the SignatureRequest. 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 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 [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (optional) @option opts [Array<Hash>] signer_file Sets a list of signers, each item is a Hash with these keys:

* role (Integer) The signer role indicated on the Template.
* name (String) Signer's name
* email_address (String) Signer's email address
* pin (Integer) Secures the SignatureRequest using this 4-12 character access code. A business plan is required 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 on 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) @option opts [Hash] signing_options Specifies the types allowed for creating a signature. (optional)

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example

signature_request = @client.send_signature_request_with_template(
  test_mode: 1,
  allow_decline: 0,
  template_id: 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
  title: 'Purchase Order',
  subject: 'Purchase Order',
  message: 'Glad we could come to an agreement.',
  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: [
    {
      CustomFieldName: '$20,000'
    }
  ],
  signing_options: {
    draw: true,
    type: true,
    upload: false,
    phone: true,
    default: 'phone'
   }
)
# File lib/hello_sign/api/signature_request.rb, line 249
def send_signature_request_with_template(opts)
  prepare_signers opts
  prepare_ccs opts
  prepare_templates opts
  prepare_custom_fields opts
  prepare_files opts

  HelloSign::Resource::SignatureRequest.new post('/signature_request/send_with_template', body: opts)
end
signature_request_files(opts) click to toggle source

Downloads a copy of the SignatureRequest documents. @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 or Zip

@example

pdf = @client.signature_request_files signature_request_id: '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
# File lib/hello_sign/api/signature_request.rb, line 452
def signature_request_files(opts)
  path = "/signature_request/files/#{opts[:signature_request_id]}"
  if opts[:file_type]
    path = path + "?file_type=#{opts[:file_type]}"
  end

  if opts[:get_url]
    separator = opts[:file_type].nil? ? '?' : '&'
    path = path + "#{separator}get_url=#{opts[:get_url]}"
  elsif opts[:get_data_uri]
    separator = opts[:file_type].nil? ? '?' : '&'
    path = path + "#{separator}get_data_uri=#{opts[:get_data_uri]}"
  end

  get(path)[:body]
end
update_signature_request(opts) click to toggle source

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.

@return [HelloSign::Resource::SignatureRequest] a SignatureRequest

@example

@client.update_signature_request(
  signature_request_id: '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
   signature_id: '5064ca698bde9581ad75f6d62450eb4b',
  email_address: 'newEmail@example.com'
)
# File lib/hello_sign/api/signature_request.rb, line 655
def update_signature_request(opts)
  signature_request_id = opts.delete(:signature_request_id)
  path = "/signature_request/update/#{signature_request_id}"
  HelloSign::Resource::SignatureRequest.new post(path, body: opts)
end