class DocusignRest::Client

Attributes

acct_id[RW]
docusign_authentication_headers[RW]
previous_call_log[RW]

Public Class Methods

new(options={}) click to toggle source
# File lib/docusign_rest/client.rb, line 12
def initialize(options={})
  # Merge the config values from the module and those passed to the client.
  merged_options = DocusignRest.options.merge(options)

  # Copy the merged values to this client and ignore those not part
  # of our configuration
  Configuration::VALID_CONFIG_KEYS.each do |key|
    send("#{key}=", merged_options[key])
  end

  # Set up the DocuSign Authentication headers with the values passed from
  # our config block
  if access_token.nil?
    @docusign_authentication_headers = {
      'X-DocuSign-Authentication' => {
        'Username' => username,
        'Password' => password,
        'IntegratorKey' => integrator_key
      }.to_json
    }
  else
    @docusign_authentication_headers = {
      'Authorization' => "Bearer #{access_token}"
    }
  end

  # Set the account_id from the configure block if present, but can't call
  # the instance var @account_id because that'll override the attr_accessor
  # that is automatically configured for the configure block
  @acct_id = account_id

  #initialize the log cache
  @previous_call_log = []
end

Public Instance Methods

add_envelope_certified_deliveries(options={}) click to toggle source

Public adds the certified delivery recipients (Need to View) for a given envelope

envelope_id - ID of the envelope for which you want to retrieve the

signer info

headers - optional hash of headers to merge into the existing

required headers for a multipart request.

certified_deliveries - A required hash of all the certified delivery recipients

that need to be added to the envelope

# The response returns the success or failure of each recipient being added to the envelope and the envelope ID

# File lib/docusign_rest/client.rb, line 1060
def add_envelope_certified_deliveries(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
    certifiedDeliveries: get_certified_deliveries(options[:certified_deliveries]),
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/recipients")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate(request, response, uri)
  JSON.parse(response.body)
end
add_envelope_document(options={}) click to toggle source

Public adds a document to a given envelope See docs.docusign.com/esign/restapi/Envelopes/EnvelopeDocuments/update/

envelope_id - ID of the envelope from which the doc will be added document_id - ID of the document to add file_path - Local or remote path to file content_type - optional content type for file. Defaults to application/pdf. file_name - optional name for file. Defaults to basename of file_path. file_extension - optional extension for file. Defaults to extname of file_name. file_io - Optional: an opened I/O stream of data (if you don't

want to read from a file)

The response only returns a success or failure.

# File lib/docusign_rest/client.rb, line 1683
def add_envelope_document(options={})
  options[:content_type] ||= 'application/pdf'
  options[:file_name] ||= File.basename(options[:file_path])
  options[:file_extension] ||= File.extname(options[:file_name])[1..-1]

  headers = {
    'Content-Type' => options[:content_type],
    'Content-Disposition' => "file; filename=\"#{options[:file_name]}\"; documentid=#{options[:document_id]}; fileExtension=\"#{options[:file_extension]}\""
  }

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/documents/#{options[:document_id]}")
  post_body = if options[:file_io].present?
    options[:file_io].read
  else
    open(options[:file_path]).read
  end

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(headers))
  request.body = post_body
  response = http.request(request)
  generate_log(request, response, uri)
  response
end
add_envelope_recipients(options={}) click to toggle source

Public: Add recipients to envelope

# File lib/docusign_rest/client.rb, line 1954
def add_envelope_recipients(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients?resend_envelope=true")

  post_body = {
    signers: get_signers(options[:signers])
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  JSON.parse(response.body)
end
add_envelope_signers(options = {}) click to toggle source

Public adds signers to a given envelope Seedocs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/

envelope_id - ID of the envelope to which the recipient will be added signers - Array of hashes

See https://docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/#definitions

TODO: This could be made more general as an add_envelope_recipient method to handle recipient types other than Signer See: docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/#examples

# File lib/docusign_rest/client.rb, line 1718
def add_envelope_signers(options = {})
  content_type = { "Content-Type" => "application/json" }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients")
  post_body = { signers: options[:signers] }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
add_recipient_tabs(options={}) click to toggle source

Public adds recipient tabs to a given envelope See docs.docusign.com/esign/restapi/Envelopes/EnvelopeRecipients/update/

envelope_id - ID of the envelope from which the doc will be added recipient - ID of the recipient to add tabs to tabs - hash of tab (see example below) {

signHereTabs: [
  {
    anchorString: '/s1/',
    anchorXOffset: '5',
    anchorYOffset: '8',
    anchorIgnoreIfNotPresent: 'true',
    documentId: '1',
    pageNumber: '1',
    recipientId: '1'
  }
],
initialHereTabs: [
  {
    anchorString: '/i1/',
    anchorXOffset: '5',
    anchorYOffset: '8',
    anchorIgnoreIfNotPresent: 'true',
    documentId: '1',
    pageNumber: '1',
    recipientId: '1'
  }
]

}

The response returns the success or failure of each document being added to the envelope and the envelope ID. Failed operations on array elements will add the “errorDetails” structure containing an error code and message. If “errorDetails” is null, then the operation was successful for that item.

# File lib/docusign_rest/client.rb, line 1769
def add_recipient_tabs(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients/#{options[:recipient_id]}/tabs")
  tabs = options[:tabs]
  index = options[:recipient_id] -  1

  post_body = {
    approveTabs:          nil,
    checkboxTabs:         nil,
    companyTabs:          nil,
    dateSignedTabs:       get_tabs(tabs[:date_signed_tabs], options, index),
    dateTabs:             nil,
    declineTabs:          nil,
    emailTabs:            nil,
    envelopeIdTabs:       nil,
    fullNameTabs:         nil,
    listTabs:             nil,
    noteTabs:             nil,
    numberTabs:           nil,
    radioGroupTabs:       nil,
    initialHereTabs:      get_tabs(tabs[:initial_here_tabs], options.merge!(initial_here_tab: true), index),
    signHereTabs:         get_tabs(tabs[:sign_here_tabs], options.merge!(sign_here_tab: true), index),
    signerAttachmentTabs: nil,
    ssnTabs:              nil,
    textTabs:             get_tabs(tabs[:text_tabs], options, index),
    titleTabs:            nil,
    zipTabs:              nil
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
build_uri(url) click to toggle source

Internal: builds a URI based on the configurable endpoint, api_version, and the passed in relative url

url - a relative url requiring a leading forward slash

Example:

build_uri('/login_information')

Returns a parsed URI object

# File lib/docusign_rest/client.rb, line 86
def build_uri(url)
  URI.parse("#{endpoint}/#{api_version}#{url}")
end
camelize(str) click to toggle source

Generic implementation to avoid having to pull in Rails dependencies

# File lib/docusign_rest/client.rb, line 466
def camelize(str)
  str.gsub(/_([a-z])/) { $1.upcase }
end
camelize_keys(hash) click to toggle source

Public: Translate ruby oriented keys to camel cased keys recursively through the hash received

The method expects symbol parameters in ruby form “:access_code” and translates them to camel cased “accessCode”

example [{access_code: '12345', email_notification: {email_body: 'abcdef'}}] -> [{'accessCode': '12345', 'emailNotification': {'emailBody': 'abcdef'}}]

# File lib/docusign_rest/client.rb, line 456
def camelize_keys(hash)
  new_hash={}
  hash.each do |k,v|
    new_hash[camelize(k.to_s)] = (v.is_a?(Hash) ? camelize_keys(v) : v)
  end
  new_hash
end
convert_hash_keys(value) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 1501
def convert_hash_keys(value)
  case value
  when Array
    value.map { |v| convert_hash_keys(v) }
  when Hash
    Hash[value.map { |k, v| [k.to_s.camelize(:lower), convert_hash_keys(v)] }]
  else
    value
  end
end
create_account(options) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 1483
def create_account(options)
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri('/accounts')

  post_body = convert_hash_keys(options).to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
create_envelope_from_composite_template(options={}) click to toggle source

Public: create an envelope for delivery from a composite template

headers - Optional hash of headers to merge into the existing

required headers for a POST request.

status - Options include: 'sent', or 'created' and

determine if the envelope is sent out immediately or
stored for sending at a later time

email/body - Sets the text in the email body email/subject - Sets the text in the email subject line files - Sets documents to be used instead of inline or server templates signers - See get_template_roles/get_inline_signers for a list

of options to pass.

headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

server_template_ids - Array of ids for templates uploaded to DocuSign. Templates

will be added in the order they appear in the array.

Returns a JSON parsed response body containing the envelope's:

envelopeId - autogenerated ID provided by Docusign
uri - the URI where the template is located on the DocuSign servers
statusDateTime - The date/time the envelope was created
status         - Sent, created, or voided
# File lib/docusign_rest/client.rb, line 954
def create_envelope_from_composite_template(options={})
  file_params = {}

  if options[:files]
    ios = create_file_ios(options[:files])
    file_params = create_file_params(ios)
  end

  post_hash = {
    emailBlurb:        "#{options[:email][:body] if options[:email]}",
    emailSubject:      "#{options[:email][:subject] if options[:email]}",
    status:             options[:status],
    brandId:            options[:brand_id],
    eventNotification:  get_event_notification(options[:event_notification]),
    allowReassign:      options[:allow_reassign],
    compositeTemplates: get_composite_template(options[:server_template_ids], options[:signers], options[:files])
  }

  post_body = post_hash.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes")

  http = initialize_net_http_ssl(uri)

  request = initialize_net_http_multipart_post_request(
              uri, post_body, file_params, headers(options[:headers])
            )

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
create_envelope_from_document(options={}) click to toggle source

Public: creates an envelope from a document directly without a template

file_io - Optional: an opened file stream of data (if you don't

want to save the file to the file system as an incremental
step)

file_path - Required if you don't provide a file_io stream, this is

the local path of the file you wish to upload. Absolute
paths recommended.

file_name - The name you want to give to the file you are uploading content_type - (for the request body) application/json is what DocuSign

is expecting

email - (Optional) short subject line for the email email - (Optional) custom text that will be injected into the

DocuSign generated email

email_settings - (Optional) array of emails to BCC. email_settings - (Optional) override the default reply to email for the account. email_settings - (Optional) override the default reply to name for the account. signers - A hash of users who should receive the document and need

to sign it. More info about the options available for
this method are documented above it's method definition.

carbon_copies - An array of hashes that includes users names and email who

should receive a copy of the document once it is complete.

status - Options include: 'sent', 'created', 'voided' and determine

if the envelope is sent out immediately or stored for
sending at a later time

customFields - (Optional) A hash of listCustomFields and textCustomFields.

Each contains an array of corresponding customField hashes.
For details, please see: http://bit.ly/1FnmRJx

headers - Allows a client to pass in some headers wet_sign - (Optional) If true, the signer is allowed to print the

document and sign it on paper. False if not defined.

Returns a JSON parsed response object containing:

envelopeId     - The envelope's ID
status         - Sent, created, or voided
statusDateTime - The date/time the envelope was created
uri            - The relative envelope uri
# File lib/docusign_rest/client.rb, line 765
def create_envelope_from_document(options={})
  ios = create_file_ios(options[:files])
  file_params = create_file_params(ios)
  recipients = if options[:certified_deliveries].nil? || options[:certified_deliveries].empty?
                 { signers: get_signers(options[:signers]) }
               else
                 { certifiedDeliveries: get_signers(options[:certified_deliveries]) }
               end


  post_hash = {
    emailBlurb:   "#{options[:email][:body] if options[:email]}",
    emailSubject: "#{options[:email][:subject] if options[:email]}",
    emailSettings: get_email_settings(options[:email_settings]),
    documents: get_documents(ios),
    recipients: {
      signers: get_signers(options[:signers]),
      carbonCopies: get_carbon_copies(options[:carbon_copies],options[:signers].size)
    },
    eventNotification: get_event_notification(options[:event_notification]),
    status: "#{options[:status]}",
    customFields: options[:custom_fields]
  }
  post_hash[:enableWetSign] = options[:wet_sign] if options.has_key? :wet_sign
  post_body = post_hash.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes")

  http = initialize_net_http_ssl(uri)

  request = initialize_net_http_multipart_post_request(
              uri, post_body, file_params, headers(options[:headers])
            )

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
create_envelope_from_template(options={}) click to toggle source

Public: create an envelope for delivery from a template

headers - Optional hash of headers to merge into the existing

required headers for a POST request.

status - Options include: 'sent', 'created', 'voided' and

determine if the envelope is sent out immediately or
stored for sending at a later time

email/body - Sets the text in the email body email/subject - Sets the text in the email subject line template_id - The id of the template upon which we want to base this

envelope

template_roles - See the get_template_roles method definition for a list

of options to pass. Note: for consistency sake we call
this 'signers' and not 'templateRoles' when we build up
the request in client code.

headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

Returns a JSON parsed response body containing the envelope's:

name - Name given above
templateId - The auto-generated ID provided by DocuSign
Uri - the URI where the template is located on the DocuSign servers
# File lib/docusign_rest/client.rb, line 902
def create_envelope_from_template(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
    status:             options[:status],
    emailBlurb:         options[:email][:body],
    emailSubject:       options[:email][:subject],
    templateId:         options[:template_id],
    enableWetSign:      options[:wet_sign],
    brandId:            options[:brand_id],
    eventNotification:  get_event_notification(options[:event_notification]),
    templateRoles:      get_template_roles(options[:signers]),
    customFields:       options[:custom_fields],
    allowReassign:      options[:allow_reassign]
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
create_file_ios(files) click to toggle source

Internal: sets up the file ios array

files - a hash of file params

Returns the properly formatted ios used to build the file_params hash

# File lib/docusign_rest/client.rb, line 563
def create_file_ios(files)
  # UploadIO is from the multipart-post gem's lib/composite_io.rb:57
  # where it has this documentation:
  #
  # ********************************************************************
  # Create an upload IO suitable for including in the params hash of a
  # Net::HTTP::Post::Multipart.
  #
  # Can take two forms. The first accepts a filename and content type, and
  # opens the file for reading (to be closed by finalizer).
  #
  # The second accepts an already-open IO, but also requires a third argument,
  # the filename from which it was opened (particularly useful/recommended if
  # uploading directly from a form in a framework, which often save the file to
  # an arbitrarily named RackMultipart file in /tmp).
  #
  # Usage:
  #
  #     UploadIO.new('file.txt', 'text/plain')
  #     UploadIO.new(file_io, 'text/plain', 'file.txt')
  # ********************************************************************
  #
  # There is also a 4th undocumented argument, opts={}, which allows us
  # to send in not only the Content-Disposition of 'file' as required by
  # DocuSign, but also the documentId parameter which is required as well
  #
  ios = []
  files.each_with_index do |file, index|
    ios << UploadIO.new(
             file[:io] || file[:path],
             file[:content_type] || 'application/pdf',
             file[:name],
             'Content-Disposition' => "file; documentid=#{index + 1}"
           )
  end
  ios
end
create_file_params(ios) click to toggle source

Internal: sets up the file_params for inclusion in a multipart post request

ios - An array of UploadIO formatted file objects

Returns a hash of files params suitable for inclusion in a multipart post request

# File lib/docusign_rest/client.rb, line 608
def create_file_params(ios)
  # multi-doc uploading capabilities, each doc needs to be it's own param
  file_params = {}
  ios.each_with_index do |io,index|
    file_params.merge!("file#{index + 1}" => io)
  end
  file_params
end
create_signing_group(options={}) click to toggle source

Public method - Creates Signing group group_name: The display name for the signing group. This can be a maximum of 100 characters. users: An array of group members for the signing group. (see example below)

It is composed of two elements:
name – The name for the group member. This can be a maximum of 100 characters.
email – The email address for the group member. This can be a maximum of 100 characters.

[

{name: 'test1', email: 'test1@ygrene.us'}
{name: 'test2', email: 'test2@ygrene.us'}

]

The response returns a success or failure with any error messages. For successes DocuSign generates a signingGroupId for each group, which is included in the response. The response also includes information about when the group was created and modified, including the account user that created and modified the group.

# File lib/docusign_rest/client.rb, line 1825
def create_signing_group(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  group_users = []
  if options[:users]
    options[:users].each do |user|
      group_users << {
        userName: user[:name],
        email: user[:email]
      }
    end
  end

  post_body = {
      groups: [
        {
          groupName: options[:group_name],
          groupType: 'sharedSigningGroup',
          users: group_users
        }
      ]
    }.to_json

  uri = build_uri("/accounts/#{@acct_id}/signing_groups")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)

  JSON.parse(response.body)
end
create_template(options={}) click to toggle source

Public: allows a template to be dynamically created with several options.

files - An array of hashes of file parameters which will be used

to create actual files suitable for upload in a multipart
request.

Options: io, path, name. The io is optional and would
require creating a file_io object to embed as the first
argument of any given file hash. See the create_file_ios
method definition above for more details.

email/body - (Optional) sets the text in the email. Note: the envelope

seems to override this, not sure why it needs to be
configured here as well. I usually leave it blank.

email/subject - (Optional) sets the text in the email. Note: the envelope

seems to override this, not sure why it needs to be
configured here as well. I usually leave it blank.

signers - An array of hashes of signers. See the

get_signers method definition for options.

description - The template description name - The template name headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

Returns a JSON parsed response body containing the template's:

name - Name given above
templateId - The auto-generated ID provided by DocuSign
Uri - the URI where the template is located on the DocuSign servers
# File lib/docusign_rest/client.rb, line 832
def create_template(options={})
  ios = create_file_ios(options[:files])
  file_params = create_file_params(ios)

  post_body = {
    emailBlurb: "#{options[:email][:body] if options[:email]}",
    emailSubject: "#{options[:email][:subject] if options[:email]}",
    documents: get_documents(ios),
    recipients: {
      signers: get_signers(options[:signers], template: true)
    },
    envelopeTemplateDefinition: {
      description: options[:description],
      name: options[:name],
      pageCount: 1,
      password: '',
      shared: false
    }
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/templates")
  http = initialize_net_http_ssl(uri)

  request = initialize_net_http_multipart_post_request(
              uri, post_body, file_params, headers(options[:headers])
            )

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
delete_account(account_id, options = {}) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 1514
def delete_account(account_id, options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{account_id}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  json = response.body
  json = '{}' if json.nil? || json == ''
  JSON.parse(json)
end
delete_envelope_document(options={}) click to toggle source

Public deletes a document for a given envelope See docs.docusign.com/esign/restapi/Envelopes/EnvelopeDocuments/delete/

envelope_id - ID of the envelope from which the doc will be retrieved document_id - ID of the document to delete

Returns the success or failure of each document being added to the envelope and the envelope ID. Failed operations on array elements will add the “errorDetails” structure containing an error code and message. If “errorDetails” is null, then the operation was successful for that item.

# File lib/docusign_rest/client.rb, line 1650
def delete_envelope_document(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/documents")
  post_body = {
    documents: [
      { documentId: options[:document_id] }
    ]
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
delete_envelope_recipient(options={}) click to toggle source

Public deletes a recipient for a given envelope

envelope_id - ID of the envelope for which you want to retrieve the

signer info

recipient_id - ID of the recipient to delete

Returns a hash of recipients with an error code for any recipients that were not successfully deleted.

# File lib/docusign_rest/client.rb, line 1596
def delete_envelope_recipient(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients")
  post_body = "{
    \"signers\" : [{\"recipientId\" : \"#{options[:recipient_id]}\"}]
   }"

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
delete_signing_groups(options={}) click to toggle source

Public method - deletes a signing group See docs.docusign.com/esign/restapi/SigningGroups/SigningGroups/delete/

signingGroupId - ID of the signing group to delete

Returns the success or failure of each group being deleted. Failed operations on array elements will add the “errorDetails” structure containing an error code and message. If “errorDetails” is null, then the operation was successful for that item.

# File lib/docusign_rest/client.rb, line 1869
def delete_signing_groups(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge!(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/signing_groups")

  groups = options[:groups]
  groups.each{|h| h[:signingGroupId] = h.delete(:signing_group_id) if h.key?(:signing_group_id)}
  post_body = {
    groups: groups
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Delete.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  JSON.parse(response.body)
end
get_account_id() click to toggle source

Internal: uses the get_login_information method to determine the client's accountId and then caches that value into an instance variable so we don't end up hitting the API for login_information more than once per request.

This is used by the rake task in lib/tasks/docusign_task.rake to add the config/initialzers/docusign_rest.rb file with the proper config block which includes the account_id in it. That way we don't require hitting the /login_information URI in normal requests

Returns the accountId string

# File lib/docusign_rest/client.rb, line 197
def get_account_id
  unless acct_id
    response = get_login_information.body
    hashed_response = JSON.parse(response)
    login_accounts = hashed_response['loginAccounts']
    @acct_id ||= login_accounts.first['accountId']
  end

  acct_id
end
get_carbon_copies(options, signer_count) click to toggle source

Internal: people to be Carbon Copied on the document that is created docs.docusign.com/esign/restapi/Envelopes/Envelopes/create/

Expecting options to be an array of hashes, with each hash representing a person to carbon copy

email - The email of the recipient to be copied on the document name - The name of the recipient signer_count - Used to generate required attributes recipientId and routingOrder which must be unique in the document

# File lib/docusign_rest/client.rb, line 439
def get_carbon_copies(options, signer_count)
  copies = []
    (options || []).each do |cc|
      signer_count += 1
      raise "Missing required data [:email, :name]" unless (cc[:email] && cc[:name])
      cc.merge!(recipient_id: signer_count, routing_order: signer_count)
      copies << camelize_keys(cc)
    end
  copies
end
get_certified_deliveries(certified_deliveries) click to toggle source

Internal: takes an array of hashes of certified deliveries

email - The recipient email name - The recipient name recipient_id - The recipient's id embedded - Tells DocuSign if this is an embedded recipient which

determines whether or not to deliver emails.
# File lib/docusign_rest/client.rb, line 477
def get_certified_deliveries(certified_deliveries)
  doc_certified_deliveries = []

  certified_deliveries.each do |certified_delivery|
    doc_certified_delivery = {
      email:        certified_delivery[:email],
      name:         certified_delivery[:name],
      recipientId:  certified_delivery[:recipient_id]
    }

    if certified_delivery[:embedded]
      doc_certified_delivery[:clientUserId] = certified_delivery[:client_id] || certified_delivery[:email]
    end

    doc_certified_deliveries << doc_certified_delivery
  end
  doc_certified_deliveries
end
get_combined_document_from_envelope(options={}) click to toggle source

Public retrieves a PDF containing the combined content of all documents and the certificate for the given envelope.

envelope_id - ID of the envelope from which the doc will be retrieved local_save_path - Local absolute path to save the doc to including the

filename itself

headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

params - Optional params; for example, certificate: true

Example

client.get_combined_document_from_envelope(
  envelope_id: @envelope_response['envelopeId'],
  local_save_path: 'docusign_docs/file_name.pdf',
  return_stream: true/false # will return the bytestream instead of saving doc to file system.
)

Returns the PDF document as a byte stream.

# File lib/docusign_rest/client.rb, line 1344
def get_combined_document_from_envelope(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/documents/combined")
  uri.query = URI.encode_www_form(options[:params]) if options[:params]

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  return response.body if options[:return_stream]

  split_path = options[:local_save_path].split('/')
  split_path.pop #removes the document name and extension from the array
  path = split_path.join("/") #rejoins the array to form path to the folder that will contain the file

  FileUtils.mkdir_p(path)
  File.open(options[:local_save_path], 'wb') do |output|
    output << response.body
  end
end
get_composite_template(server_template_ids, signers, files) click to toggle source

Internal: takes in an array of server template ids and an array of the signers and sets up the composite template

Takes an optional array of files, which consist of documents to be used instead of templates

Returns an array of server template hashes

# File lib/docusign_rest/client.rb, line 637
def get_composite_template(server_template_ids, signers, files)
  composite_array = []
  server_template_ids.each_with_index do |template_id, idx|
    server_template_hash = {
        sequence: (idx+1).to_s,
        templateId: template_id,
        templateRoles: get_template_roles(signers),
    }
    templates_hash = {
      serverTemplates: [server_template_hash],
      inlineTemplates: get_inline_signers(signers, (idx+1).to_s)
    }
    if files
      document_hash = {
          documentId: (idx+1).to_s,
          name: "#{files[idx][:name] if files[idx]}"
      }
      templates_hash[:document] = document_hash
    end
    composite_array << templates_hash
  end
  composite_array
end
get_console_view(options={}) click to toggle source

Public returns the URL for embedded console

envelope_id - the ID of the envelope you wish to use for embedded signing headers - optional hash of headers to merge into the existing

required headers for a multipart request.

Returns the URL string for embedded console (can be put in an iFrame)

# File lib/docusign_rest/client.rb, line 1147
def get_console_view(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
    envelopeId: options[:envelope_id]
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/views/console")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  parsed_response = JSON.parse(response.body)
  parsed_response['url']
end
get_document_from_envelope(options={}) click to toggle source

Public retrieves the attached file from a given envelope

envelope_id - ID of the envelope from which the doc will be retrieved document_id - ID of the document to retrieve local_save_path - Local absolute path to save the doc to including the

filename itself

headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

Example

client.get_document_from_envelope(
  envelope_id: @envelope_response['envelopeId'],
  document_id: 1,
  local_save_path: 'docusign_docs/file_name.pdf',
  return_stream: true/false # will return the bytestream instead of saving doc to file system.
)

Returns the PDF document as a byte stream.

# File lib/docusign_rest/client.rb, line 1283
def get_document_from_envelope(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/documents/#{options[:document_id]}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  return response.body if options[:return_stream]

  split_path = options[:local_save_path].split('/')
  split_path.pop #removes the document name and extension from the array
  path = split_path.join("/") #rejoins the array to form path to the folder that will contain the file

  FileUtils.mkdir_p(path)
  File.open(options[:local_save_path], 'wb') do |output|
    output << response.body
  end
end
get_document_tabs(options) click to toggle source

Public fetches custom fields for a document

options - ID of the envelope which you want to send options - ID of the envelope which you want to send

Returns the custom fields Hash.

# File lib/docusign_rest/client.rb, line 993
def get_document_tabs(options)
  content_type = { 'Content-Type' => 'application/json' }
  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/documents/#{options[:document_id]}/tabs")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_documents(ios) click to toggle source

Internal: takes in an array of hashes of documents and calculates the documentId

Returns a hash of documents that are to be uploaded

# File lib/docusign_rest/client.rb, line 622
def get_documents(ios)
  ios.each_with_index.map do |io, index|
    {
      documentId: "#{index + 1}",
      name: io.original_filename
    }
  end
end
get_documents_from_envelope(options={}) click to toggle source

Public retrieves the document infos from a given envelope

envelope_id - ID of the envelope from which document infos are to be retrieved

Returns a hash containing the envelopeId and the envelopeDocuments array

# File lib/docusign_rest/client.rb, line 1311
def get_documents_from_envelope(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/documents")

  http     = initialize_net_http_ssl(uri)
  request  = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_envelope(envelope_id) click to toggle source

Grabs envelope data. Equivalent to the following call in the API explorer: Get Envelopev2/accounts/:accountId/envelopes/:envelopeId

envelope_id- DS id of envelope to be retrieved.

# File lib/docusign_rest/client.rb, line 1576
def get_envelope(envelope_id)
  content_type = { 'Content-Type' => 'application/json' }
  uri = build_uri("/accounts/#{acct_id}/envelopes/#{envelope_id}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_envelope_audit_events(options = {}) click to toggle source

Public returns a hash of audit events for a given envelope

envelope_id - ID of the envelope to get audit events from

Example client.get_envelope_audit_events(

envelope_id: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"

) Returns a hash of the events that have happened to the envelope.

# File lib/docusign_rest/client.rb, line 1412
def get_envelope_audit_events(options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/audit_events")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_envelope_recipients(options={}) click to toggle source

Public returns the envelope recipients for a given envelope

include_tabs - boolean, determines if the tabs for each signer will be

returned in the response, defaults to false.

envelope_id - ID of the envelope for which you want to retrieve the

signer info

headers - optional hash of headers to merge into the existing

required headers for a multipart request.

Returns a hash of detailed info about the envelope including the signer hash and status of each signer

# File lib/docusign_rest/client.rb, line 1180
def get_envelope_recipients(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  include_tabs = options[:include_tabs] || false
  include_extended = options[:include_extended] || false
  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/recipients?include_tabs=#{include_tabs}&include_extended=#{include_extended}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_envelope_status(options={}) click to toggle source

Public retrieves the envelope status

envelope_id - ID of the envelope from which the doc will be retrieved

# File lib/docusign_rest/client.rb, line 1199
def get_envelope_status(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_envelope_statuses(options={}) click to toggle source

Public retrieves the statuses of envelopes matching the given query

from_date - Docusign formatted Date/DateTime. Only return items after this date.

to_date - Docusign formatted Date/DateTime. Only return items up to this date.

Defaults to the time of the call.

from_to_status - The status of the envelope checked for in the from_date - to_date period.

Defaults to 'changed'

envelope_ids - Comma joined list of envelope_ids which you want to query.

status - The current status of the envelope. Defaults to any status.

Returns an array of hashes containing envelope statuses, ids, and similar information.

# File lib/docusign_rest/client.rb, line 1228
def get_envelope_statuses(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  query_params = options.slice(:from_date, :to_date, :from_to_status, :envelope_ids, :status)
  # Note that Hash#to_query is an ActiveSupport monkeypatch
  uri = build_uri("/accounts/#{acct_id}/envelopes?#{query_params.to_query}")

  http     = initialize_net_http_ssl(uri)
  request  = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_event_notification(event_notification) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 288
def get_event_notification(event_notification)
  return {} unless event_notification
  {
    useSoapInterface:          event_notification[:use_soap_interface] || false,
    includeCertificateWithSoap: event_notification[:include_certificate_with_soap] || false,
    url:                       event_notification[:url],
    loggingEnabled:            event_notification[:logging],
    'envelopeEvents' => Array(event_notification[:envelope_events]).map do |envelope_event|
      {
        includeDocuments:        envelope_event[:include_documents] || false,
        envelopeEventStatusCode: envelope_event[:envelope_event_status_code]
      }
    end,
    'recipientEvents' => Array(event_notification[:recipient_events]).map do |recipient_event|
      {
        includeDocuments:         recipient_event[:include_documents] || false,
        recipientEventStatusCode: recipient_event[:recipient_event_status_code]
      }
    end
  }
end
get_folder_list(options={}) click to toggle source

Public retrieves folder information. Helpful to use before client.search_folder_for_envelopes

# File lib/docusign_rest/client.rb, line 1426
def get_folder_list(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/folders/")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_inline_signers(signers, sequence) click to toggle source

Internal: takes signer info and the inline template sequence number and sets up the inline template

Returns an array of signers

# File lib/docusign_rest/client.rb, line 666
def get_inline_signers(signers, sequence)
  signers_array = []
  signers.each do |signer|
    signers_hash = {
      email: signer[:email],
      name: signer[:name],
      recipientId: signer[:recipient_id],
      roleName: signer[:role_name],
      clientUserId: signer[:client_id] || signer[:email],
      requireSignOnPaper: signer[:require_sign_on_paper] || false,
      tabs: {
        textTabs:       get_signer_tabs(signer[:text_tabs]),
        radioGroupTabs: get_radio_signer_tabs(signer[:radio_group_tabs]),
        checkboxTabs:   get_signer_tabs(signer[:checkbox_tabs]),
        numberTabs:     get_signer_tabs(signer[:number_tabs]),
        fullNameTabs:   get_signer_tabs(signer[:fullname_tabs]),
        dateTabs:       get_signer_tabs(signer[:date_tabs]),
        signHereTabs:   get_sign_here_tabs(signer[:sign_here_tabs])
      }
    }
    signers_array << signers_hash
  end
  template_hash = {sequence: sequence, recipients: { signers: signers_array }}
  [template_hash]
end
get_login_information(options={}) click to toggle source

Public: gets info necessary to make additional requests to the DocuSign API

options - hash of headers if the client wants to override something

Examples:

client = DocusignRest::Client.new
response = client.login_information
puts response.body

Returns:

accountId - For the username, password, and integrator_key specified
baseUrl   - The base URL for all future DocuSign requests
email     - The email used when signing up for DocuSign
isDefault - # TODO identify what this is
name      - The account name provided when signing up for DocuSign
userId    - # TODO determine what this is used for, if anything
userName  - Full name provided when signing up for DocuSign
# File lib/docusign_rest/client.rb, line 176
def get_login_information(options={})
  uri = build_uri('/login_information')
  request = Net::HTTP::Get.new(uri.request_uri, headers(options[:headers]))
  http = initialize_net_http_ssl(uri)
  response = http.request(request)
  generate_log(request, response, uri)
  response
end
get_page_image(options={}) click to toggle source

Public retrieves a png of a page of a document in an envelope

envelope_id - ID of the envelope from which the doc will be retrieved document_id - ID of the document to retrieve page_number - page number to retrieve

Returns the png as a bytestream

# File lib/docusign_rest/client.rb, line 1250
def get_page_image(options={})
  envelope_id = options[:envelope_id]
  document_id = options[:document_id]
  page_number = options[:page_number]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{envelope_id}/documents/#{document_id}/pages/#{page_number}/page_image")

  http     = initialize_net_http_ssl(uri)
  request  = Net::HTTP::Get.new(uri.request_uri, headers)
  response = http.request(request)
  generate_log(request, response, uri)
  response.body
end
get_radio_signer_tabs(tabs) click to toggle source
# File lib/docusign_rest/client.rb, line 277
def get_radio_signer_tabs(tabs)
  Array(tabs).map do |tab|
    {
      'documentId' => tab[:document_id],
      'groupName' => tab[:group_name],
      'radios' => tab[:radios],
    }
  end
end
get_recipient_names(options={}) click to toggle source

Public returns the names specified for a given email address (existing docusign user)

email - the email of the recipient headers - optional hash of headers to merge into the existing

required headers for a multipart request.

Returns the list of names

# File lib/docusign_rest/client.rb, line 1034
def get_recipient_names(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/recipient_names?email=#{options[:email]}")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_recipient_view(options={}) click to toggle source

Public returns the URL for embedded signing

envelope_id - the ID of the envelope you wish to use for embedded signing name - the name of the signer email - the email of the recipient return_url - the URL you want the user to be directed to after he or she

completes the document signing

headers - optional hash of headers to merge into the existing

required headers for a multipart request.

Returns the URL string for embedded signing (can be put in an iFrame)

# File lib/docusign_rest/client.rb, line 1091
def get_recipient_view(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
    authenticationMethod: 'email',
    clientUserId:         options[:client_id] || options[:email],
    email:                options[:email],
    returnUrl:            options[:return_url],
    userName:             options[:name]
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/views/recipient")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_sender_view(options = {}) click to toggle source

Public returns the URL for embedded sending

envelope_id - the ID of the envelope you wish to use return_url - the URL you want the user to be directed to after he or she

closes the view

headers - optional hash of headers to merge into the existing

required headers for a multipart request.

Returns the URL string for embedded sending

# File lib/docusign_rest/client.rb, line 1124
def get_sender_view(options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}/views/sender")

  http = initialize_net_http_ssl(uri)

  request = Net::HTTP::Post.new(uri.request_uri, headers(content_type))
  request.body = { returnUrl: options[:return_url] }.to_json

  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_sign_here_tabs(tabs) click to toggle source
# File lib/docusign_rest/client.rb, line 251
def get_sign_here_tabs(tabs)
  Array(tabs).map do |tab|
    {
      documentId: tab[:document_id],
      recipientId: tab[:recipient_id],
      anchorString: tab[:anchor_string],
      anchorXOffset: tab[:anchorXOffset],
      anchorYOffset: tab[:anchorYOffset]
    }
  end
end
get_signer_tabs(tabs) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 264
def get_signer_tabs(tabs)
  Array(tabs).map do |tab|
    {
      'tabLabel' => tab[:label],
      'name' => tab[:name],
      'value' => tab[:value],
      'documentId' => tab[:document_id],
      'selected' => tab[:selected],
      'locked' => tab[:locked]
    }
  end
end
get_signers(signers, options={}) click to toggle source

Internal: takes an array of hashes of signers required to complete a document and allows for setting several options. Not all options are currently dynamic but that's easy to change/add which I (and I'm sure others) will be doing in the future.

template - Includes other optional fields only used when

being called from a template

email - The signer's email name - The signer's name embedded - Tells DocuSign if this is an embedded signer which

determines whether or not to deliver emails. Also
lets us authenticate them when they go to do
embedded signing. Behind the scenes this is setting
the clientUserId value to the signer's email.

email_notification - Send an email or not role_name - The signer's role, like 'Attorney' or 'Client', etc. template_locked - Doesn't seem to work/do anything template_required - Doesn't seem to work/do anything anchor_string - The string of text to anchor the 'sign here' tab to document_id - If the doc you want signed isn't the first doc in

the files options hash

page_number - Page number of the sign here tab x_position - Distance horizontally from the anchor string for the

'sign here' tab to appear. Note: doesn't seem to
currently work.

y_position - Distance vertically from the anchor string for the

'sign here' tab to appear. Note: doesn't seem to
currently work.

sign_here_tab_text - Instead of 'sign here'. Note: doesn't work tab_label - TODO: figure out what this is

# File lib/docusign_rest/client.rb, line 341
def get_signers(signers, options={})
  doc_signers = []

  signers.each_with_index do |signer, index|
    doc_signer = {
      accessCode:                            '',
      addAccessCodeToEmail:                  false,
      customFields:                          signer[:custom_fields],
      idCheckConfigurationName:              signer[:id_check_configuration_name],
      idCheckInformationInput:               nil,
      inheritEmailNotificationConfiguration: false,
      note:                                  signer[:note],
      phoneAuthentication:                   nil,
      recipientAttachment:                   nil,
      requireIdLookup:                       signer[:require_id_lookup],
      requireSignOnPaper:                    signer[:require_sign_on_paper] || false,
      roleName:                              signer[:role_name],
      routingOrder:                          signer[:routing_order] || index + 1,
      socialAuthentications:                 nil
    }

    recipient_id = signer[:recipient_id] || index + 1
    doc_signer[:recipientId] = recipient_id
    doc_signer[:clientUserId] = recipient_id if signer[:embedded_signing]

    if signer[:id_check_information_input]
      doc_signer[:idCheckInformationInput] =
        get_id_check_information_input(signer[:id_check_information_input])
    end

    if signer[:phone_authentication]
      doc_signer[:phoneAuthentication] =
        get_phone_authentication(signer[:phone_authentication])
    end

    if signer[:signing_group_id]
      doc_signer[:signingGroupId] = signer[:signing_group_id]
    else
      doc_signer[:email] = signer[:email]
      doc_signer[:name] = signer[:name]
    end

    if signer[:email_notification]
      doc_signer[:emailNotification] = signer[:email_notification]
    end

    if signer[:embedded]
      doc_signer[:clientUserId] = signer[:client_id] || signer[:email]
    end

    if options[:template] == true
      doc_signer[:templateAccessCodeRequired] = false
      doc_signer[:templateLocked]             = signer[:template_locked].nil? ? true : signer[:template_locked]
      doc_signer[:templateRequired]           = signer[:template_required].nil? ? true : signer[:template_required]
    end

    doc_signer[:autoNavigation]   = false
    doc_signer[:defaultRecipient] = false
    doc_signer[:signatureInfo]    = nil
    doc_signer[:tabs]             = {
      approveTabs:          nil,
      checkboxTabs:         get_tabs(signer[:checkbox_tabs], options, index),
      companyTabs:          nil,
      dateSignedTabs:       get_tabs(signer[:date_signed_tabs], options, index),
      dateTabs:             nil,
      declineTabs:          nil,
      emailTabs:            get_tabs(signer[:email_tabs], options, index),
      envelopeIdTabs:       nil,
      fullNameTabs:         get_tabs(signer[:full_name_tabs], options, index),
      listTabs:             get_tabs(signer[:list_tabs], options, index),
      noteTabs:             nil,
      numberTabs:           get_tabs(signer[:number_tabs], options, index),
      radioGroupTabs:       get_tabs(signer[:radio_group_tabs], options, index),
      initialHereTabs:      get_tabs(signer[:initial_here_tabs], options.merge!(initial_here_tab: true), index),
      signHereTabs:         get_tabs(signer[:sign_here_tabs], options.merge!(sign_here_tab: true), index),
      signerAttachmentTabs: nil,
      ssnTabs:              nil,
      textTabs:             get_tabs(signer[:text_tabs], options, index),
      titleTabs:            get_tabs(signer[:title_tabs], options, index),
      zipTabs:              nil
    }

    # append the fully build string to the array
    doc_signers << doc_signer
  end
  doc_signers
end
get_signing_groups() click to toggle source

Public: Retrieves a list of available signing groups

# File lib/docusign_rest/client.rb, line 1920
def get_signing_groups
  uri = build_uri("/accounts/#{@acct_id}/signing_groups")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers({ 'Content-Type' => 'application/json' }))
  JSON.parse(http.request(request).body)
end
get_tabs(tabs, options, index) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 497
def get_tabs(tabs, options, index)
  tab_array = []

  Array(tabs).map do |tab|
    tab_hash = {}

    if tab[:anchor_string]
      tab_hash[:anchorString]             = tab[:anchor_string]
      tab_hash[:anchorXOffset]            = tab[:anchor_x_offset] || '0'
      tab_hash[:anchorYOffset]            = tab[:anchor_y_offset] || '0'
      tab_hash[:anchorIgnoreIfNotPresent] = tab[:ignore_anchor_if_not_present] || false
      tab_hash[:anchorUnits]              = 'pixels'
    end

    tab_hash[:conditionalParentLabel]   = tab[:conditional_parent_label] if tab.key?(:conditional_parent_label)
    tab_hash[:conditionalParentValue]   = tab[:conditional_parent_value] if tab.key?(:conditional_parent_value)
    tab_hash[:documentId]               = tab[:document_id] || '1'
    tab_hash[:pageNumber]               = tab[:page_number] || '1'
    tab_hash[:recipientId]              = index + 1
    tab_hash[:required]                 = tab[:required] || false

    if options[:template] == true
      tab_hash[:templateLocked]   = tab[:template_locked].nil? ? true : tab[:template_locked]
      tab_hash[:templateRequired] = tab[:template_required].nil? ? true : tab[:template_required]
    end

    if options[:sign_here_tab] == true || options[:initial_here_tab] == true
      tab_hash[:scaleValue] = tab[:scale_value] || 1
    end

    tab_hash[:xPosition]  = tab[:x_position] || '0'
    tab_hash[:yPosition]  = tab[:y_position] || '0'
    tab_hash[:name]       = tab[:name] if tab[:name]
    tab_hash[:optional]   = tab[:optional] || false
    tab_hash[:tabLabel]   = tab[:label] || 'Signature 1'
    tab_hash[:width]      = tab[:width] if tab[:width]
    tab_hash[:height]     = tab[:height] if tab[:height]
    tab_hash[:value]      = tab[:value] if tab[:value]
    tab_hash[:fontSize]   = tab[:font_size] if tab[:font_size]
    tab_hash[:fontColor]  = tab[:font_color] if tab[:font_color]
    tab_hash[:bold]       = tab[:bold] if tab[:bold]
    tab_hash[:italic]     = tab[:italic] if tab[:italic]
    tab_hash[:underline]  = tab[:underline] if tab[:underline]
    tab_hash[:selected]   = tab[:selected] if tab[:selected]

    tab_hash[:locked]     = tab[:locked] || false

    tab_hash[:list_items] = tab[:list_items] if tab[:list_items]

    tab_hash[:groupName] = tab[:group_name] if tab.key?(:group_name)
    tab_hash[:radios] = get_tabs(tab[:radios], options, index) if tab.key?(:radios)

    tab_hash[:validationMessage] = tab[:validation_message] if tab[:validation_message]
    tab_hash[:validationPattern] = tab[:validation_pattern] if tab[:validation_pattern]

    tab_array << tab_hash
  end
  tab_array
end
get_template(template_id, options = {}) click to toggle source

TODO (2014-02-03) jonk => document

# File lib/docusign_rest/client.rb, line 866
def get_template(template_id, options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{acct_id}/templates/#{template_id}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_template_roles(signers) click to toggle source

Internal: takes in an array of hashes of signers and concatenates all the hashes with commas

embedded - Tells DocuSign if this is an embedded signer which determines

whether or not to deliver emails. Also lets us authenticate
them when they go to do embedded signing. Behind the scenes
this is setting the clientUserId value to the signer's email.

name - The name of the signer email - The email of the signer role_name - The role name of the signer ('Attorney', 'Client', etc.). tabs - Array of tab pairs grouped by type (Example type: 'textTabs')

{ textTabs: [ { tabLabel: "label", name: "name", value: "value" } ] }

Returns a hash of users that need to be embedded in the template to create an envelope

# File lib/docusign_rest/client.rb, line 224
def get_template_roles(signers)
  template_roles = []
  signers.each_with_index do |signer, index|
    template_role = {
      name:     signer[:name],
      email:    signer[:email],
      roleName: signer[:role_name],
      tabs: {
        textTabs:     get_signer_tabs(signer[:text_tabs]),
        checkboxTabs: get_signer_tabs(signer[:checkbox_tabs]),
        numberTabs:   get_signer_tabs(signer[:number_tabs]),
        radioGroupTabs: get_radio_signer_tabs(signer[:radio_group_tabs]),
        fullNameTabs: get_signer_tabs(signer[:fullname_tabs]),
        dateTabs:     get_signer_tabs(signer[:date_tabs])
      }
    }

    if signer[:email_notification]
      template_role[:emailNotification] = signer[:email_notification]
    end

    template_role['clientUserId'] = (signer[:client_id] || signer[:email]).to_s if signer[:embedded] == true
    template_roles << template_role
  end
  template_roles
end
get_templates(options={}) click to toggle source

Public: Retrieves a list of available templates

params: Can contain a folder

Example

client.get_templates()

or

client.get_templates(params: {folder: "somefolder"})

Returns a list of the available templates.

# File lib/docusign_rest/client.rb, line 1543
def get_templates(options={})
  uri = build_uri("/accounts/#{acct_id}/templates")
  uri.query = URI.encode_www_form(options[:params]) if options[:params]

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers({ 'Content-Type' => 'application/json' }))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_templates_in_envelope(envelope_id) click to toggle source

Public: Retrieves a list of templates used in an envelope

Returns templateId, name and uri for each template found.

envelope_id - DS id of envelope with templates.

# File lib/docusign_rest/client.rb, line 1560
def get_templates_in_envelope(envelope_id)
  uri = build_uri("/accounts/#{acct_id}/envelopes/#{envelope_id}/templates")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers({ 'Content-Type' => 'application/json' }))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_token(integrator_key, email, password) click to toggle source

Public: creates an OAuth2 authorization server token endpoint.

email - email of user authenticating password - password of user authenticating

Examples:

client = DocusignRest::Client.new
response = client.get_token(integrator_key, 'someone@example.com', 'p@ssw0rd01')

Returns:

access_token - Access token information
scope - This should always be "api"
token_type - This should always be "bearer"
# File lib/docusign_rest/client.rb, line 144
def get_token(integrator_key, email, password)
  content_type = { 'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json' }
  uri = build_uri('/oauth2/token')

  request = Net::HTTP::Post.new(uri.request_uri, content_type)
  request.body = "grant_type=password&client_id=#{integrator_key}&username=#{email}&password=#{password}&scope=api"

  http = initialize_net_http_ssl(uri)
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
get_users_list(options={}) click to toggle source

Public method - get list of users See developers.docusign.com/esign-rest-api/reference/Users

Returns a list of users

# File lib/docusign_rest/client.rb, line 1976
def get_users_list(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge!(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/users?additional_info=true")

  request = Net::HTTP::Get.new(uri.request_uri, headers(options[:headers]))
  http = initialize_net_http_ssl(uri)
  response = http.request(request)
  generate_log(request, response, uri)

  parsed_response = JSON.parse(response.body)
  (parsed_response || {}).fetch("users", [])
end
headers(user_defined_headers={}) click to toggle source

Internal: sets the default request headers allowing for user overrides via options from within other requests. Additionally injects the X-DocuSign-Authentication header to authorize the request.

Client can pass in header options to any given request: headers: {'Some-Key' => 'some/value', 'Another-Key' => 'another/value'}

Then we pass them on to this method to merge them with the other required headers

Example:

headers(options[:headers])

Returns a merged hash of headers overriding the default Accept header if the user passes in a new 'Accept' header key and adds any other user-defined headers along with the X-DocuSign-Authentication headers

# File lib/docusign_rest/client.rb, line 65
def headers(user_defined_headers={})
  default = {
    'Accept' => 'json' #this seems to get added automatically, so I can probably remove this
  }

  default.merge!(user_defined_headers) if user_defined_headers

  @docusign_authentication_headers.merge(default)
end
initialize_net_http_multipart_post_request(uri, post_body, file_params, headers) click to toggle source

Internal sets up the Net::HTTP request

uri - The fully qualified final URI post_body - The custom post body including the signers, etc file_params - Formatted hash of ios to merge into the post body headers - Allows for passing in custom headers

Returns a request object suitable for embedding in a request

# File lib/docusign_rest/client.rb, line 701
def initialize_net_http_multipart_post_request(uri, post_body, file_params, headers)
  # Net::HTTP::Post::Multipart is from the multipart-post gem's lib/multipartable.rb
  #
  # path       - The fully qualified URI for the request
  # params     - A hash of params (including files for uploading and a
  #              customized request body)
  # headers={} - The fully merged, final request headers
  # boundary   - Optional: you can give the request a custom boundary
  #

  headers = headers.dup.merge(parts: {post_body: {'Content-Type' => 'application/json'}})

  request = Net::HTTP::Post::Multipart.new(
    uri.request_uri,
    { post_body: post_body }.merge(file_params),
    headers
  )

  # DocuSign requires that we embed the document data in the body of the
  # JSON request directly so we need to call '.read' on the multipart-post
  # provided body_stream in order to serialize all the files into a
  # compatible JSON string.
  request.body = request.body_stream.read
  request
end
initialize_net_http_ssl(uri) click to toggle source

Internal: configures Net:HTTP with some default values that are required for every request to the DocuSign API

Returns a configured Net::HTTP object into which a request can be passed

# File lib/docusign_rest/client.rb, line 95
def initialize_net_http_ssl(uri)
  http = Net::HTTP.new(uri.host, uri.port)

  http.use_ssl = uri.scheme == 'https'

  if defined?(Rails) && Rails.env.test?
    in_rails_test_env = true
  else
    in_rails_test_env = false
  end

  if http.use_ssl? && !in_rails_test_env
    if ca_file
      if File.exists?(ca_file)
        http.ca_file = ca_file
      else
        raise 'Certificate path not found.'
      end
    end

    # Explicitly verifies that the certificate matches the domain.
    # Requires that we use www when calling the production DocuSign API
    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
    http.verify_depth = 5
  else
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end

  http.open_timeout = open_timeout
  http.read_timeout = read_timeout

  http
end
move_envelope_to_folder(options = {}) click to toggle source

Public moves the specified envelopes to the given folder

envelope_ids - IDs of the envelopes to be moved folder_id - ID of the folder to move the envelopes to headers - Optional hash of headers to merge into the existing

required headers for a multipart request.

Example

client.move_envelope_to_folder(
  envelope_ids: ["xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"]
  folder_id: "xxxxx-2222xxxxx",
)

Returns the response.

# File lib/docusign_rest/client.rb, line 1383
def move_envelope_to_folder(options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
    envelopeIds: options[:envelope_ids]
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/folders/#{options[:folder_id]}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body
  response = http.request(request)
  generate_log(request, response, uri)
  response
end
search_folder_for_envelopes(options={}) click to toggle source

Public retrieves the envelope(s) from a specific folder based on search params.

Option Query Terms(none are required): query_params:

start_position: Integer The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
from_date:      date/Time Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
to_date:        date/Time Only return items up to this date. If no value is provided, the default search is to the current date.
search_text:    String   The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
status:         Status  The current status of the envelope. If no value is provided, the default search is all/any status.
owner_name:     username  The name of the folder owner.
owner_email:    email The email of the folder owner.

Example

client.search_folder_for_envelopes(
  folder_id: xxxxx-2222xxxxx,
  query_params: {
    search_text: "John Appleseed",
    from_date: '7-1-2011+11:00:00+AM',
    to_date: '7-1-2011+11:00:00+AM',
    status: "completed"
  }
)
# File lib/docusign_rest/client.rb, line 1463
def search_folder_for_envelopes(options={})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  q ||= []
  options[:query_params].each do |key, val|
    q << "#{key}=#{val}"
  end

  uri = build_uri("/accounts/#{@acct_id}/folders/#{options[:folder_id]}/?#{q.join('&')}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Get.new(uri.request_uri, headers(content_type))
  response = http.request(request)
  generate_log(request, response, uri)
  JSON.parse(response.body)
end
send_envelope(envelope_id) click to toggle source

Public marks an envelope as sent

envelope_id - ID of the envelope which you want to send

Returns the response (success or failure).

# File lib/docusign_rest/client.rb, line 1009
def send_envelope(envelope_id)
  content_type = { 'Content-Type' => 'application/json' }

  post_body = {
    status: 'sent'
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{envelope_id}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body
  response = http.request(request)

  JSON.parse(response.body)
end
update_envelope_recipients(options={}) click to toggle source

Public: Update envelope recipients

# File lib/docusign_rest/client.rb, line 1929
def update_envelope_recipients(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge(options[:headers]) if options[:headers]

  resend = options[:resend].present?
  uri = build_uri("/accounts/#{@acct_id}/envelopes/#{options[:envelope_id]}/recipients?resend_envelope=#{resend}")

  signers = options[:signers]
  signers.each do |signer|
   signer[:recipientId] = signer.delete(:recipient_id) if signer.key?(:recipient_id)
   signer[:clientUserId] = signer.delete(:client_user_id) if signer.key?(:client_user_id)
  end
  post_body = {
    signers: signers
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  JSON.parse(response.body)
end
update_signing_group_users(options={}) click to toggle source

Public method - updates signing group users See docs.docusign.com/esign/restapi/SigningGroups/SigningGroupUsers/update/

signingGroupId - ID of the signing group to update

Returns the success or failure of each user being updated. Failed operations on array elements will add the “errorDetails” structure containing an error code and message. If “errorDetails” is null, then the operation was successful for that item.

# File lib/docusign_rest/client.rb, line 1897
def update_signing_group_users(options={})
  content_type = {'Content-Type' => 'application/json'}
  content_type.merge!(options[:headers]) if options[:headers]

  uri = build_uri("/accounts/#{@acct_id}/signing_groups/#{options[:signing_group_id]}/users")

  users = options[:users]
  users.each do |user|
   user[:userName] = user.delete(:user_name) if user.key?(:user_name)
  end
  post_body = {
    users: users
  }.to_json

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body

  response = http.request(request)
  JSON.parse(response.body)
end
void_envelope(options = {}) click to toggle source

Public voids an in-process envelope

envelope_id - ID of the envelope to be voided voided_reason - Optional reason for the envelope being voided

Returns the response (success or failure).

# File lib/docusign_rest/client.rb, line 1621
def void_envelope(options = {})
  content_type = { 'Content-Type' => 'application/json' }
  content_type.merge(options[:headers]) if options[:headers]

  post_body = {
      "status" =>"voided",
      "voidedReason" => options[:voided_reason] || "No reason provided."
  }.to_json

  uri = build_uri("/accounts/#{acct_id}/envelopes/#{options[:envelope_id]}")

  http = initialize_net_http_ssl(uri)
  request = Net::HTTP::Put.new(uri.request_uri, headers(content_type))
  request.body = post_body
  response = http.request(request)
  generate_log(request, response, uri)
  response
end

Private Instance Methods

generate_log(request, response, uri) click to toggle source

Private: Generates a standardized log of the request and response pair to and from DocuSign for logging and API Certification. and resulting list is set to the publicly accessible: @previous_call_log For example: envelope = connection.create_envelope_from_document(doc) connection.previous_call_log.each {|line| logger.debug line }

# File lib/docusign_rest/client.rb, line 1999
def generate_log(request, response, uri)
  log = ['--DocuSign REQUEST--']
  log << "#{request.method} #{uri.to_s}"
  request.each_capitalized{ |k,v| log << "#{k}: #{v.gsub(/(?<="Password":")(.+?)(?=")/, '[FILTERED]')}" }
  # Trims out the actual binary file to reduce log size
  if request.body
    request_body = begin
      request.body.gsub(/(?<=Content-Transfer-Encoding: binary).+?(?=-------------RubyMultipartPost)/m, "\n[BINARY BLOB]\n")
    rescue ArgumentError => ae
      if ae.message == "invalid byte sequence in UTF-8"
        request.body.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').gsub(/^%PDF.*%%EOF/m, "\n[PDF BLOB]\n")
      else
        raise
      end
    end
    log << "Body: #{request_body}"
  end
  log << '--DocuSign RESPONSE--'
  log << "HTTP/#{response.http_version} #{response.code} #{response.msg}"
  response.each_capitalized{ |k,v| log << "#{k}: #{v}" }
  log << "Body: #{response.body}"
  @previous_call_log = log
end
get_address_information_input(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2032
def get_address_information_input(input)
  return {} unless input
  {
    addressInformation:{
      street1: input[:street1],
      city: input[:city],
      state: input[:state],
      zip: input[:zip],
      zipPlus4: input[:zip_plus4],
    },
    displayLevelCode: 'DoNotDisplay',
    receiveInResponse: true,
  }
end
get_dob_information_input(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2066
def get_dob_information_input(input)
  return {} unless input
  {
    dateOfBirth: input[:date_of_birth],
    displayLevelCode: 'DoNotDisplay',
    receiveInResponse: true,
  }
end
get_email_settings(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2075
def get_email_settings(input)
  return {} unless input
  {
    bccEmailAddresses: input[:bcc_email_addresses],
    replyEmailAddressOverride: input[:reply_to_email],
    replyEmailNameOverride: input[:reply_to_name]
  }
end
get_id_check_information_input(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2023
def get_id_check_information_input(input)
  {
    addressInformationInput: get_address_information_input(
      input.dig(:address_information_input, :address_information)),
    ssn4InformationInput: get_ssn4_information_input(input[:ssn4_information_input]),
    dobInformationInput: get_dob_information_input(input[:dob_information_input])
  }
end
get_phone_authentication(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2047
def get_phone_authentication(input)
  return {} unless input
  {
    recipMayProvideNumber: true,
    validateRecipProvidedNumber: true,
    recordVoicePrint: true,
    senderProvidedNumbers: input[:sender_provided_numbers],
  }
end
get_ssn4_information_input(input) click to toggle source
# File lib/docusign_rest/client.rb, line 2057
def get_ssn4_information_input(input)
  return {} unless input
  {
    ssn4: input[:ssn4],
    displayLevelCode: 'DoNotDisplay',
    receiveInResponse: true,
  }
end