Class: DocuSign_eSign::OcrRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/ocr_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OcrRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# 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

Instance Attribute Details

#ocr_language ⇒ Object

Returns the value of attribute ocr_language.



18
19
20
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 18

def ocr_language
  @ocr_language
end

#page_selection ⇒ Object

Returns the value of attribute page_selection.



21
22
23
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 21

def page_selection
  @page_selection
end

#set_page_orientation ⇒ Object

Returns the value of attribute set_page_orientation.



24
25
26
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 24

def set_page_orientation
  @set_page_orientation
end

#show_frames ⇒ Object

Returns the value of attribute show_frames.



27
28
29
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 27

def show_frames
  @show_frames
end

#show_text ⇒ Object

Returns the value of attribute show_text.



30
31
32
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 30

def show_text
  @show_text
end

#skip_pages_having_existing_extractable_text ⇒ Object

Returns the value of attribute skip_pages_having_existing_extractable_text.



33
34
35
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 33

def skip_pages_having_existing_extractable_text
  @skip_pages_having_existing_extractable_text
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
117
118
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# 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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


122
123
124
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 122

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



96
97
98
99
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 96

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 202

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



196
197
198
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 196

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



103
104
105
 
# File 'lib/docusign_esign/models/ocr_request.rb', line 103

def valid?
  return true
end