class DocuSign_eSign::EnvelopeDocument

This object contains details about the envelope document.

Attributes

added_recipient_ids[RW]

attachment_tab_id[RW]

authoritative_copy[RW]

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

authoritative_copy_metadata[RW]

Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.

available_document_types[RW]

contains_pdf_form_fields[RW]

display[RW]

display_metadata[RW]

Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.

doc_gen_document_status[RW]

doc_gen_errors[RW]

doc_gen_form_fields[RW]

document_base64[RW]

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.

document_id_guid[RW]

error_details[RW]

Array or errors.

include_in_download[RW]

include_in_download_metadata[RW]

Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.

is_ace_gen_document[RW]

is_doc_gen_document[RW]

name[RW]

name_metadata[RW]

Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.

order[RW]

pages[RW]

signer_must_acknowledge[RW]

signer_must_acknowledge_metadata[RW]

Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.

size_bytes[RW]

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.

type[RW]

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/envelope_document.rb, line 111
def self.attribute_map
  {
    :'added_recipient_ids' => :'addedRecipientIds',
    :'attachment_tab_id' => :'attachmentTabId',
    :'authoritative_copy' => :'authoritativeCopy',
    :'authoritative_copy_metadata' => :'authoritativeCopyMetadata',
    :'available_document_types' => :'availableDocumentTypes',
    :'contains_pdf_form_fields' => :'containsPdfFormFields',
    :'display' => :'display',
    :'display_metadata' => :'displayMetadata',
    :'doc_gen_document_status' => :'docGenDocumentStatus',
    :'doc_gen_errors' => :'docGenErrors',
    :'doc_gen_form_fields' => :'docGenFormFields',
    :'document_base64' => :'documentBase64',
    :'document_fields' => :'documentFields',
    :'document_id' => :'documentId',
    :'document_id_guid' => :'documentIdGuid',
    :'error_details' => :'errorDetails',
    :'include_in_download' => :'includeInDownload',
    :'include_in_download_metadata' => :'includeInDownloadMetadata',
    :'is_ace_gen_document' => :'isAceGenDocument',
    :'is_doc_gen_document' => :'isDocGenDocument',
    :'name' => :'name',
    :'name_metadata' => :'nameMetadata',
    :'order' => :'order',
    :'pages' => :'pages',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'signer_must_acknowledge_metadata' => :'signerMustAcknowledgeMetadata',
    :'size_bytes' => :'sizeBytes',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'type' => :'type',
    :'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/envelope_document.rb, line 186
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?(:'addedRecipientIds')
    if (value = attributes[:'addedRecipientIds']).is_a?(Array)
      self.added_recipient_ids = value
    end
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'docGenErrors')
    if (value = attributes[:'docGenErrors']).is_a?(Array)
      self.doc_gen_errors = value
    end
  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?(:'documentIdGuid')
    self.document_id_guid = attributes[:'documentIdGuid']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'sizeBytes')
    self.size_bytes = attributes[:'sizeBytes']
  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?(:'type')
    self.type = attributes[:'type']
  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/envelope_document.rb, line 148
def self.swagger_types
  {
    :'added_recipient_ids' => :'Array<String>',
    :'attachment_tab_id' => :'String',
    :'authoritative_copy' => :'String',
    :'authoritative_copy_metadata' => :'PropertyMetadata',
    :'available_document_types' => :'Array<SignatureType>',
    :'contains_pdf_form_fields' => :'String',
    :'display' => :'String',
    :'display_metadata' => :'PropertyMetadata',
    :'doc_gen_document_status' => :'String',
    :'doc_gen_errors' => :'Array<DocGenSyntaxError>',
    :'doc_gen_form_fields' => :'Array<DocGenFormField>',
    :'document_base64' => :'String',
    :'document_fields' => :'Array<NameValue>',
    :'document_id' => :'String',
    :'document_id_guid' => :'String',
    :'error_details' => :'ErrorDetails',
    :'include_in_download' => :'String',
    :'include_in_download_metadata' => :'PropertyMetadata',
    :'is_ace_gen_document' => :'String',
    :'is_doc_gen_document' => :'String',
    :'name' => :'String',
    :'name_metadata' => :'PropertyMetadata',
    :'order' => :'String',
    :'pages' => :'Array<Page>',
    :'signer_must_acknowledge' => :'String',
    :'signer_must_acknowledge_metadata' => :'PropertyMetadata',
    :'size_bytes' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'type' => :'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/envelope_document.rb, line 344
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      added_recipient_ids == o.added_recipient_ids &&
      attachment_tab_id == o.attachment_tab_id &&
      authoritative_copy == o.authoritative_copy &&
      authoritative_copy_metadata == o.authoritative_copy_metadata &&
      available_document_types == o.available_document_types &&
      contains_pdf_form_fields == o.contains_pdf_form_fields &&
      display == o.display &&
      display_metadata == o.display_metadata &&
      doc_gen_document_status == o.doc_gen_document_status &&
      doc_gen_errors == o.doc_gen_errors &&
      doc_gen_form_fields == o.doc_gen_form_fields &&
      document_base64 == o.document_base64 &&
      document_fields == o.document_fields &&
      document_id == o.document_id &&
      document_id_guid == o.document_id_guid &&
      error_details == o.error_details &&
      include_in_download == o.include_in_download &&
      include_in_download_metadata == o.include_in_download_metadata &&
      is_ace_gen_document == o.is_ace_gen_document &&
      is_doc_gen_document == o.is_doc_gen_document &&
      name == o.name &&
      name_metadata == o.name_metadata &&
      order == o.order &&
      pages == o.pages &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
      signer_must_acknowledge_metadata == o.signer_must_acknowledge_metadata &&
      size_bytes == o.size_bytes &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      type == o.type &&
      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/envelope_document.rb, line 416
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/envelope_document.rb, line 482
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/envelope_document.rb, line 395
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/envelope_document.rb, line 382
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/envelope_document.rb, line 388
def hash
  [added_recipient_ids, attachment_tab_id, authoritative_copy, authoritative_copy_metadata, available_document_types, contains_pdf_form_fields, display, display_metadata, doc_gen_document_status, doc_gen_errors, doc_gen_form_fields, document_base64, document_fields, document_id, document_id_guid, error_details, include_in_download, include_in_download_metadata, is_ace_gen_document, is_doc_gen_document, name, name_metadata, order, pages, signer_must_acknowledge, signer_must_acknowledge_metadata, size_bytes, template_locked, template_required, type, 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/envelope_document.rb, line 331
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/envelope_document.rb, line 462
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/envelope_document.rb, line 468
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/envelope_document.rb, line 456
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/envelope_document.rb, line 338
def valid?
  true
end