class CloudmersiveOcrApiClient::ReceiptRecognitionResult

Result of recognizing a receipt, to extract the key information from the receipt

Attributes

address_string[RW]

The address of the business printed on the receipt (if included on the receipt)

business_name[RW]

The name of the business printed on the receipt (if included on the receipt)

business_website[RW]

The website URL of the business printed on the receipt (if included on the receipt)

phone_number[RW]

The phone number printed on the receipt (if included on the receipt)

receipt_items[RW]

The individual line items comprising the order; does not include total (see ReceiptTotal)

receipt_sub_total[RW]

Optional; if available, the monetary value of the receipt subtotal - typically not including specialized line items such as Tax. If this value is not available, it will be 0.

receipt_total[RW]

The total monetary value of the receipt (if included on the receipt)

successful[RW]

True if the operation was successful, false otherwise

timestamp[RW]

The date and time printed on the receipt (if included on the receipt)

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 46
def self.attribute_map
  {
    :'successful' => :'Successful',
    :'timestamp' => :'Timestamp',
    :'business_name' => :'BusinessName',
    :'business_website' => :'BusinessWebsite',
    :'address_string' => :'AddressString',
    :'phone_number' => :'PhoneNumber',
    :'receipt_items' => :'ReceiptItems',
    :'receipt_sub_total' => :'ReceiptSubTotal',
    :'receipt_total' => :'ReceiptTotal'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 77
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?(:'Successful')
    self.successful = attributes[:'Successful']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'ReceiptTotal')
    self.receipt_total = attributes[:'ReceiptTotal']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 61
def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'timestamp' => :'DateTime',
    :'business_name' => :'String',
    :'business_website' => :'String',
    :'address_string' => :'String',
    :'phone_number' => :'String',
    :'receipt_items' => :'Array<ReceiptLineItem>',
    :'receipt_sub_total' => :'Float',
    :'receipt_total' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 137
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      timestamp == o.timestamp &&
      business_name == o.business_name &&
      business_website == o.business_website &&
      address_string == o.address_string &&
      phone_number == o.phone_number &&
      receipt_items == o.receipt_items &&
      receipt_sub_total == o.receipt_sub_total &&
      receipt_total == o.receipt_total
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 187
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
_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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 253
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 166
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 153
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 159
def hash
  [successful, timestamp, business_name, business_website, address_string, phone_number, receipt_items, receipt_sub_total, receipt_total].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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 124
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 233
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 239
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 227
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/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb, line 131
def valid?
  true
end