Class: CloudmersiveOcrApiClient::BusinessCardRecognitionResult
- Inherits:
-
Object
- Object
- CloudmersiveOcrApiClient::BusinessCardRecognitionResult
- Defined in:
- lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb
Overview
Result of recognizing a business card, to extract the key information from the business card
Instance Attribute Summary collapse
-
#address_string ⇒ Object
The address printed on the business card (if included on the business card).
-
#business_name ⇒ Object
The name of the business printed on the business card (if included on the business card).
-
#email_address ⇒ Object
The email address printed on the business card (if included on the business card).
-
#person_name ⇒ Object
The name of the person printed on the business card (if included on the business card).
-
#person_title ⇒ Object
The title of the person printed on the business card (if included on the business card).
-
#phone_number ⇒ Object
The phone number printed on the business card (if included on the business card).
-
#successful ⇒ Object
True if the operation was successful, false otherwise.
-
#timestamp ⇒ Object
The date and time printed on the business card (if included on the business card).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BusinessCardRecognitionResult
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ BusinessCardRecognitionResult
Initializes the object
72 73 74 75 76 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 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 72 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?(:'PersonName') self.person_name = attributes[:'PersonName'] end if attributes.has_key?(:'PersonTitle') self.person_title = attributes[:'PersonTitle'] end if attributes.has_key?(:'BusinessName') self.business_name = attributes[:'BusinessName'] 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?(:'EmailAddress') self.email_address = attributes[:'EmailAddress'] end if attributes.has_key?(:'Timestamp') self. = attributes[:'Timestamp'] end end |
Instance Attribute Details
#address_string ⇒ Object
The address printed on the business card (if included on the business card)
31 32 33 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 31 def address_string @address_string end |
#business_name ⇒ Object
The name of the business printed on the business card (if included on the business card)
28 29 30 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 28 def business_name @business_name end |
#email_address ⇒ Object
The email address printed on the business card (if included on the business card)
37 38 39 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 37 def email_address @email_address end |
#person_name ⇒ Object
The name of the person printed on the business card (if included on the business card)
22 23 24 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 22 def person_name @person_name end |
#person_title ⇒ Object
The title of the person printed on the business card (if included on the business card)
25 26 27 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 25 def person_title @person_title end |
#phone_number ⇒ Object
The phone number printed on the business card (if included on the business card)
34 35 36 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 34 def phone_number @phone_number end |
#successful ⇒ Object
True if the operation was successful, false otherwise
19 20 21 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 19 def successful @successful end |
#timestamp ⇒ Object
The date and time printed on the business card (if included on the business card)
40 41 42 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 40 def @timestamp end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 43 def self.attribute_map { :'successful' => :'Successful', :'person_name' => :'PersonName', :'person_title' => :'PersonTitle', :'business_name' => :'BusinessName', :'address_string' => :'AddressString', :'phone_number' => :'PhoneNumber', :'email_address' => :'EmailAddress', :'timestamp' => :'Timestamp' } end |
.swagger_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 57 def self.swagger_types { :'successful' => :'BOOLEAN', :'person_name' => :'String', :'person_title' => :'String', :'business_name' => :'String', :'address_string' => :'String', :'phone_number' => :'String', :'email_address' => :'String', :'timestamp' => :'DateTime' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 126 def ==(o) return true if self.equal?(o) self.class == o.class && successful == o.successful && person_name == o.person_name && person_title == o.person_title && business_name == o.business_name && address_string == o.address_string && phone_number == o.phone_number && email_address == o.email_address && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
175 176 177 178 179 180 181 182 183 184 185 186 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 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 175 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
241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 241 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
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 154 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
141 142 143 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 141 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
147 148 149 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 147 def hash [successful, person_name, person_title, business_name, address_string, phone_number, email_address, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
113 114 115 116 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 113 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
221 222 223 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 221 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
227 228 229 230 231 232 233 234 235 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 227 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
215 216 217 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 215 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
120 121 122 |
# File 'lib/cloudmersive-ocr-api-client/models/business_card_recognition_result.rb', line 120 def valid? true end |