Class: CloudmersiveOcrApiClient::ReceiptRecognitionResult

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReceiptRecognitionResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# 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

Instance Attribute Details

#address_string ⇒ Object

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



31
32
33
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 31

def address_string
  @address_string
end

#business_name ⇒ Object

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



25
26
27
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 25

def business_name
  @business_name
end

#business_website ⇒ Object

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



28
29
30
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 28

def business_website
  @business_website
end

#phone_number ⇒ Object

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



34
35
36
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 34

def phone_number
  @phone_number
end

#receipt_items ⇒ Object

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



37
38
39
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 37

def receipt_items
  @receipt_items
end

#receipt_sub_total ⇒ Object

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.



40
41
42
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 40

def receipt_sub_total
  @receipt_sub_total
end

#receipt_total ⇒ Object

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



43
44
45
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 43

def receipt_total
  @receipt_total
end

#successful ⇒ Object

True if the operation was successful, false otherwise



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 19

def successful
  @successful
end

#timestamp ⇒ Object

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



22
23
24
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 22

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



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

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# 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) ⇒ 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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 153

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# 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 ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



124
125
126
127
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 233

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



239
240
241
242
243
244
245
246
247
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



227
228
229
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 227

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



131
132
133
 
# File 'lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb', line 131

def valid?
  true
end