Class: Plaid::PhysicalDocumentExtractedData

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/physical_document_extracted_data.rb

Overview

Data extracted from a user-submitted document.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhysicalDocumentExtractedData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PhysicalDocumentExtractedData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::PhysicalDocumentExtractedData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id_number')
    self.id_number = attributes[:'id_number']
  end

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.key?(:'expiration_date')
    self.expiration_date = attributes[:'expiration_date']
  end

  if attributes.key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

  if attributes.key?(:'issuing_country')
    self.issuing_country = attributes[:'issuing_country']
  end

  if attributes.key?(:'issuing_region')
    self.issuing_region = attributes[:'issuing_region']
  end

  if attributes.key?(:'date_of_birth')
    self.date_of_birth = attributes[:'date_of_birth']
  end

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



39
40
41
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 39

def address
  @address
end

#category ⇒ Object

Returns the value of attribute category.



22
23
24
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 22

def category
  @category
end

#date_of_birth ⇒ Object

A date extracted from the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).



37
38
39
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 37

def date_of_birth
  @date_of_birth
end

#expiration_date ⇒ Object

The expiration date of the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).



25
26
27
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 25

def expiration_date
  @expiration_date
end

#id_number ⇒ Object

Alpha-numeric ID number extracted via OCR from the user’s document image.



20
21
22
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 20

def id_number
  @id_number
end

#issue_date ⇒ Object

The issue date of the document in the format YYYY-MM-DD (RFC 3339 Section 5.6).



28
29
30
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 28

def issue_date
  @issue_date
end

#issuing_country ⇒ Object

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.



31
32
33
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 31

def issuing_country
  @issuing_country
end

#issuing_region ⇒ Object

A subdivision code. "Subdivision" is a generic term for "state", "province", "prefecture", "zone", etc. For the list of valid codes, see [country subdivision codes](plaid.com/documents/country_subdivision_codes.json). Country prefixes are omitted, since they are inferred from the ‘country` field.



34
35
36
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 34

def issuing_region
  @issuing_region
end

#name ⇒ Object

Returns the value of attribute name.



41
42
43
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 41

def name
  @name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 66

def self.attribute_map
  {
    :'id_number' => :'id_number',
    :'category' => :'category',
    :'expiration_date' => :'expiration_date',
    :'issue_date' => :'issue_date',
    :'issuing_country' => :'issuing_country',
    :'issuing_region' => :'issuing_region',
    :'date_of_birth' => :'date_of_birth',
    :'address' => :'address',
    :'name' => :'name'
  }
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



219
220
221
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 219

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 101

def self.openapi_nullable
  Set.new([
    :'id_number',
    :'expiration_date',
    :'issue_date',
    :'issuing_region',
    :'date_of_birth',
    :'address',
    :'name'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 86

def self.openapi_types
  {
    :'id_number' => :'String',
    :'category' => :'PhysicalDocumentCategory',
    :'expiration_date' => :'Date',
    :'issue_date' => :'Date',
    :'issuing_country' => :'String',
    :'issuing_region' => :'String',
    :'date_of_birth' => :'Date',
    :'address' => :'IdentityVerificationDocumentAddressResponse',
    :'name' => :'IdentityVerificationDocumentNameResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id_number == o.id_number &&
      category == o.category &&
      expiration_date == o.expiration_date &&
      issue_date == o.issue_date &&
      issuing_country == o.issuing_country &&
      issuing_region == o.issuing_region &&
      date_of_birth == o.date_of_birth &&
      address == o.address &&
      name == o.name
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 250

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 321

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 212

def hash
  [id_number, category, expiration_date, issue_date, issuing_country, issuing_region, date_of_birth, address, name].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



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 167

def list_invalid_properties
  invalid_properties = Array.new
  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

  if @issuing_country.nil?
    invalid_properties.push('invalid value for "issuing_country", issuing_country cannot be nil.')
  end

  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



297
298
299
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 297

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 303

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



291
292
293
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 291

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



182
183
184
185
186
 
# File 'lib/plaid/models/physical_document_extracted_data.rb', line 182

def valid?
  return false if @category.nil?
  return false if @issuing_country.nil?
  true
end