Method: Echosign::Client#get_library_document_file

Defined in:
lib/echosign/library_documents/client.rb

#get_library_document_file(library_document_id, file_id, file_path = nil) ⇒ String

Retrieves library document file data

Parameters:

  • library_document_id (REQUIRED)
  • file_id (String) —

    (REQUIRED)

  • file_path (String) (defaults to: nil) —

    File path for saving the document. If none is given, nothing will be saved to disk.

Returns:

  • (String) —

    Raw library document file data



36
37
38
39
40
41
42
43
44
 
# File 'lib/echosign/library_documents/client.rb', line 36

def get_library_document_file(library_document_id, file_id, file_path = nil)
  response = request(:get_library_document_file, library_document_id, file_id)
  unless file_path.nil?
    file = File.new(file_path, 'wb')
    file.write(response)
    file.close
  end
  response
end