cloudmersive-ocr-api-client 1.3.9 → 1.4.0

data/lib/cloudmersive-ocr-api-client/models/form_definition_template.rb

@@ -0,0 +1,190 @@
+=begin
+#ocrapi
+
+#The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveOcrApiClient
+  # Definition of a form template; use a form template definition to recognize the fields in a form with Cloudmersive OCR
+  class FormDefinitionTemplate
+    attr_accessor :field_definitions
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'field_definitions' => :'FieldDefinitions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'field_definitions' => :'Array<FormFieldDefinition>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'FieldDefinitions')
+        if (value = attributes[:'FieldDefinitions']).is_a?(Array)
+          self.field_definitions = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          field_definitions == o.field_definitions
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [field_definitions].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 = CloudmersiveOcrApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/cloudmersive-ocr-api-client/models/form_field_definition.rb

@@ -0,0 +1,298 @@
+=begin
+#ocrapi
+
+#The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module CloudmersiveOcrApiClient
+  # Definition of a form field for OCR data extraction from images
+  class FormFieldDefinition
+    attr_accessor :field_id
+
+    attr_accessor :left_anchor
+
+    attr_accessor :top_anchor
+
+    attr_accessor :anchor_mode
+
+    attr_accessor :data_type
+
+    attr_accessor :target_digit_count
+
+    attr_accessor :minimum_character_count
+
+    attr_accessor :allow_numeric_digits
+
+    attr_accessor :vertical_alignment_type
+
+    attr_accessor :horizontal_alignment_type
+
+    attr_accessor :target_field_width_relative
+
+    attr_accessor :target_field_height_relative
+
+    attr_accessor :ignore
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'field_id' => :'FieldID',
+        :'left_anchor' => :'LeftAnchor',
+        :'top_anchor' => :'TopAnchor',
+        :'anchor_mode' => :'AnchorMode',
+        :'data_type' => :'DataType',
+        :'target_digit_count' => :'TargetDigitCount',
+        :'minimum_character_count' => :'MinimumCharacterCount',
+        :'allow_numeric_digits' => :'AllowNumericDigits',
+        :'vertical_alignment_type' => :'VerticalAlignmentType',
+        :'horizontal_alignment_type' => :'HorizontalAlignmentType',
+        :'target_field_width_relative' => :'TargetFieldWidth_Relative',
+        :'target_field_height_relative' => :'TargetFieldHeight_Relative',
+        :'ignore' => :'Ignore'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'field_id' => :'String',
+        :'left_anchor' => :'String',
+        :'top_anchor' => :'String',
+        :'anchor_mode' => :'String',
+        :'data_type' => :'String',
+        :'target_digit_count' => :'Integer',
+        :'minimum_character_count' => :'Integer',
+        :'allow_numeric_digits' => :'BOOLEAN',
+        :'vertical_alignment_type' => :'String',
+        :'horizontal_alignment_type' => :'String',
+        :'target_field_width_relative' => :'Float',
+        :'target_field_height_relative' => :'Float',
+        :'ignore' => :'Array<String>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'FieldID')
+        self.field_id = attributes[:'FieldID']
+      end
+
+      if attributes.has_key?(:'LeftAnchor')
+        self.left_anchor = attributes[:'LeftAnchor']
+      end
+
+      if attributes.has_key?(:'TopAnchor')
+        self.top_anchor = attributes[:'TopAnchor']
+      end
+
+      if attributes.has_key?(:'AnchorMode')
+        self.anchor_mode = attributes[:'AnchorMode']
+      end
+
+      if attributes.has_key?(:'DataType')
+        self.data_type = attributes[:'DataType']
+      end
+
+      if attributes.has_key?(:'TargetDigitCount')
+        self.target_digit_count = attributes[:'TargetDigitCount']
+      end
+
+      if attributes.has_key?(:'MinimumCharacterCount')
+        self.minimum_character_count = attributes[:'MinimumCharacterCount']
+      end
+
+      if attributes.has_key?(:'AllowNumericDigits')
+        self.allow_numeric_digits = attributes[:'AllowNumericDigits']
+      end
+
+      if attributes.has_key?(:'VerticalAlignmentType')
+        self.vertical_alignment_type = attributes[:'VerticalAlignmentType']
+      end
+
+      if attributes.has_key?(:'HorizontalAlignmentType')
+        self.horizontal_alignment_type = attributes[:'HorizontalAlignmentType']
+      end
+
+      if attributes.has_key?(:'TargetFieldWidth_Relative')
+        self.target_field_width_relative = attributes[:'TargetFieldWidth_Relative']
+      end
+
+      if attributes.has_key?(:'TargetFieldHeight_Relative')
+        self.target_field_height_relative = attributes[:'TargetFieldHeight_Relative']
+      end
+
+      if attributes.has_key?(:'Ignore')
+        if (value = attributes[:'Ignore']).is_a?(Array)
+          self.ignore = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          field_id == o.field_id &&
+          left_anchor == o.left_anchor &&
+          top_anchor == o.top_anchor &&
+          anchor_mode == o.anchor_mode &&
+          data_type == o.data_type &&
+          target_digit_count == o.target_digit_count &&
+          minimum_character_count == o.minimum_character_count &&
+          allow_numeric_digits == o.allow_numeric_digits &&
+          vertical_alignment_type == o.vertical_alignment_type &&
+          horizontal_alignment_type == o.horizontal_alignment_type &&
+          target_field_width_relative == o.target_field_width_relative &&
+          target_field_height_relative == o.target_field_height_relative &&
+          ignore == o.ignore
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [field_id, left_anchor, top_anchor, anchor_mode, data_type, target_digit_count, minimum_character_count, allow_numeric_digits, vertical_alignment_type, horizontal_alignment_type, target_field_width_relative, target_field_height_relative, ignore].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 = CloudmersiveOcrApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end