Class: Echosign::UrlFileInfo

Inherits:
Hash
  • Object
show all
Includes:
Validatable
Defined in:
lib/echosign/agreement/url_file_info.rb

Instance Method Summary collapse

Methods included from Validatable

#require_exactly_one, #require_keys, #validate_field

Constructor Details

#initialize(params) ⇒ UrlFileInfo

Validates UrlFileInfo parameters

Parameters:

  • params (Hash) —

    SYMBOL-referenced Hash

Options Hash (params):

  • :url (String) —

    A publicly accessible URL for retrieving the raw file content. HTTP authentication is supported using standard embedded syntax - i.e. username:[email protected]/path/to/file (REQUIRED)

  • :mimeType (String) —

    The mime type of the referenced file, used to determine if the file can be accepted and the necessary conversion steps can be performed.

  • :name (String) —

    The original system file name of the document being sent - used to name attachments, and to infer the mime type if one is not explicitly specified



15
16
17
18
 
# File 'lib/echosign/agreement/url_file_info.rb', line 15

def initialize(params)
  require_keys([:url], params)
  merge! params
end