class DocuSign_eSign::OcrRequest

Attributes

ocr_language[RW]
page_selection[RW]
set_page_orientation[RW]
show_frames[RW]
show_text[RW]
skip_pages_having_existing_extractable_text[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/ocr_request.rb, line 37
def self.attribute_map
  {
    :'ocr_language' => :'ocrLanguage',
    :'page_selection' => :'pageSelection',
    :'set_page_orientation' => :'setPageOrientation',
    :'show_frames' => :'showFrames',
    :'show_text' => :'showText',
    :'skip_pages_having_existing_extractable_text' => :'skipPagesHavingExistingExtractableText'
  }
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/ocr_request.rb, line 62
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?(:'ocrLanguage')
    self.ocr_language = attributes[:'ocrLanguage']
  end

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/ocr_request.rb, line 49
def self.swagger_types
  {
    :'ocr_language' => :'String',
    :'page_selection' => :'String',
    :'set_page_orientation' => :'String',
    :'show_frames' => :'String',
    :'show_text' => :'String',
    :'skip_pages_having_existing_extractable_text' => :'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/ocr_request.rb, line 109
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ocr_language == o.ocr_language &&
      page_selection == o.page_selection &&
      set_page_orientation == o.set_page_orientation &&
      show_frames == o.show_frames &&
      show_text == o.show_text &&
      skip_pages_having_existing_extractable_text == o.skip_pages_having_existing_extractable_text
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/ocr_request.rb, line 156
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/ocr_request.rb, line 222
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/ocr_request.rb, line 135
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 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/ocr_request.rb, line 122
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/ocr_request.rb, line 128
def hash
  [ocr_language, page_selection, set_page_orientation, show_frames, show_text, skip_pages_having_existing_extractable_text].hash
end
list_invalid_properties() click to toggle source

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

# File lib/docusign_esign/models/ocr_request.rb, line 96
def list_invalid_properties
  invalid_properties = Array.new
  return 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/ocr_request.rb, line 202
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/ocr_request.rb, line 208
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/ocr_request.rb, line 196
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/ocr_request.rb, line 103
def valid?
  return true
end