class DocuSign_eSign::Document

A document object.

Attributes

apply_anchor_tabs[RW]

Reserved: TBD

assign_tabs_to_recipient_id[RW]

authoritative_copy[RW]

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

display[RW]

doc_gen_form_fields[RW]

document_base64[RW]

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

document_fields[RW]

document_id[RW]

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

encrypted_with_key_manager[RW]

When set to *true*, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

file_extension[RW]

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

file_format_hint[RW]

html_definition[RW]

Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).

include_in_download[RW]

is_doc_gen_document[RW]

match_boxes[RW]

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

name[RW]

order[RW]

pages[RW]

password[RW]

pdf_form_field_option[RW]

remote_url[RW]

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

signer_must_acknowledge[RW]

signer_must_acknowledge_use_account_default[RW]

tabs[RW]

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

template_locked[RW]

When set to *true*, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

template_required[RW]

When set to *true*, the sender may not remove the recipient. Used only when working with template recipients.

transform_pdf_fields[RW]

When set to *true*, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

uri[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docusign_esign/models/document.rb, line 102
def self.attribute_map
  {
    :'apply_anchor_tabs' => :'applyAnchorTabs',
    :'assign_tabs_to_recipient_id' => :'assignTabsToRecipientId',
    :'authoritative_copy' => :'authoritativeCopy',
    :'display' => :'display',
    :'doc_gen_form_fields' => :'docGenFormFields',
    :'document_base64' => :'documentBase64',
    :'document_fields' => :'documentFields',
    :'document_id' => :'documentId',
    :'encrypted_with_key_manager' => :'encryptedWithKeyManager',
    :'file_extension' => :'fileExtension',
    :'file_format_hint' => :'fileFormatHint',
    :'html_definition' => :'htmlDefinition',
    :'include_in_download' => :'includeInDownload',
    :'is_doc_gen_document' => :'isDocGenDocument',
    :'match_boxes' => :'matchBoxes',
    :'name' => :'name',
    :'order' => :'order',
    :'pages' => :'pages',
    :'password' => :'password',
    :'pdf_form_field_option' => :'pdfFormFieldOption',
    :'remote_url' => :'remoteUrl',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'signer_must_acknowledge_use_account_default' => :'signerMustAcknowledgeUseAccountDefault',
    :'tabs' => :'tabs',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'transform_pdf_fields' => :'transformPdfFields',
    :'uri' => :'uri'
  }
end

new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/document.rb, line 171
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'applyAnchorTabs')
    self.apply_anchor_tabs = attributes[:'applyAnchorTabs']
  end

  if attributes.has_key?(:'assignTabsToRecipientId')
    self.assign_tabs_to_recipient_id = attributes[:'assignTabsToRecipientId']
  end

  if attributes.has_key?(:'authoritativeCopy')
    self.authoritative_copy = attributes[:'authoritativeCopy']
  end

  if attributes.has_key?(:'display')
    self.display = attributes[:'display']
  end

  if attributes.has_key?(:'docGenFormFields')
    if (value = attributes[:'docGenFormFields']).is_a?(Array)
      self.doc_gen_form_fields = value
    end
  end

  if attributes.has_key?(:'documentBase64')
    self.document_base64 = attributes[:'documentBase64']
  end

  if attributes.has_key?(:'documentFields')
    if (value = attributes[:'documentFields']).is_a?(Array)
      self.document_fields = value
    end
  end

  if attributes.has_key?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'encryptedWithKeyManager')
    self.encrypted_with_key_manager = attributes[:'encryptedWithKeyManager']
  end

  if attributes.has_key?(:'fileExtension')
    self.file_extension = attributes[:'fileExtension']
  end

  if attributes.has_key?(:'fileFormatHint')
    self.file_format_hint = attributes[:'fileFormatHint']
  end

  if attributes.has_key?(:'htmlDefinition')
    self.html_definition = attributes[:'htmlDefinition']
  end

  if attributes.has_key?(:'includeInDownload')
    self.include_in_download = attributes[:'includeInDownload']
  end

  if attributes.has_key?(:'isDocGenDocument')
    self.is_doc_gen_document = attributes[:'isDocGenDocument']
  end

  if attributes.has_key?(:'matchBoxes')
    if (value = attributes[:'matchBoxes']).is_a?(Array)
      self.match_boxes = value
    end
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'order')
    self.order = attributes[:'order']
  end

  if attributes.has_key?(:'pages')
    self.pages = attributes[:'pages']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'pdfFormFieldOption')
    self.pdf_form_field_option = attributes[:'pdfFormFieldOption']
  end

  if attributes.has_key?(:'remoteUrl')
    self.remote_url = attributes[:'remoteUrl']
  end

  if attributes.has_key?(:'signerMustAcknowledge')
    self.signer_must_acknowledge = attributes[:'signerMustAcknowledge']
  end

  if attributes.has_key?(:'signerMustAcknowledgeUseAccountDefault')
    self.signer_must_acknowledge_use_account_default = attributes[:'signerMustAcknowledgeUseAccountDefault']
  end

  if attributes.has_key?(:'tabs')
    self.tabs = attributes[:'tabs']
  end

  if attributes.has_key?(:'templateLocked')
    self.template_locked = attributes[:'templateLocked']
  end

  if attributes.has_key?(:'templateRequired')
    self.template_required = attributes[:'templateRequired']
  end

  if attributes.has_key?(:'transformPdfFields')
    self.transform_pdf_fields = attributes[:'transformPdfFields']
  end

  if attributes.has_key?(:'uri')
    self.uri = attributes[:'uri']
  end
end

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/document.rb, line 136
def self.swagger_types
  {
    :'apply_anchor_tabs' => :'String',
    :'assign_tabs_to_recipient_id' => :'String',
    :'authoritative_copy' => :'BOOLEAN',
    :'display' => :'String',
    :'doc_gen_form_fields' => :'Array<DocGenFormField>',
    :'document_base64' => :'String',
    :'document_fields' => :'Array<NameValue>',
    :'document_id' => :'String',
    :'encrypted_with_key_manager' => :'String',
    :'file_extension' => :'String',
    :'file_format_hint' => :'String',
    :'html_definition' => :'DocumentHtmlDefinition',
    :'include_in_download' => :'String',
    :'is_doc_gen_document' => :'String',
    :'match_boxes' => :'Array<MatchBox>',
    :'name' => :'String',
    :'order' => :'String',
    :'pages' => :'String',
    :'password' => :'String',
    :'pdf_form_field_option' => :'String',
    :'remote_url' => :'String',
    :'signer_must_acknowledge' => :'String',
    :'signer_must_acknowledge_use_account_default' => :'BOOLEAN',
    :'tabs' => :'Tabs',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'transform_pdf_fields' => :'String',
    :'uri' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/document.rb, line 311
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_anchor_tabs == o.apply_anchor_tabs &&
      assign_tabs_to_recipient_id == o.assign_tabs_to_recipient_id &&
      authoritative_copy == o.authoritative_copy &&
      display == o.display &&
      doc_gen_form_fields == o.doc_gen_form_fields &&
      document_base64 == o.document_base64 &&
      document_fields == o.document_fields &&
      document_id == o.document_id &&
      encrypted_with_key_manager == o.encrypted_with_key_manager &&
      file_extension == o.file_extension &&
      file_format_hint == o.file_format_hint &&
      html_definition == o.html_definition &&
      include_in_download == o.include_in_download &&
      is_doc_gen_document == o.is_doc_gen_document &&
      match_boxes == o.match_boxes &&
      name == o.name &&
      order == o.order &&
      pages == o.pages &&
      password == o.password &&
      pdf_form_field_option == o.pdf_form_field_option &&
      remote_url == o.remote_url &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
      signer_must_acknowledge_use_account_default == o.signer_must_acknowledge_use_account_default &&
      tabs == o.tabs &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      transform_pdf_fields == o.transform_pdf_fields &&
      uri == o.uri
end

_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/document.rb, line 380
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docusign_esign/models/document.rb, line 446
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/document.rb, line 359
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/document.rb, line 346
def eql?(o)
  self == o
end

hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/document.rb, line 352
def hash
  [apply_anchor_tabs, assign_tabs_to_recipient_id, authoritative_copy, display, doc_gen_form_fields, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, is_doc_gen_document, match_boxes, name, order, pages, password, pdf_form_field_option, remote_url, signer_must_acknowledge, signer_must_acknowledge_use_account_default, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
end

list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/document.rb, line 298
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/document.rb, line 426
def to_body
  to_hash
end

to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/document.rb, line 432
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/document.rb, line 420
def to_s
  to_hash.to_s
end

valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/document.rb, line 305
def valid?
  true
end