Class: Onfido::DocumentBreakdown

Inherits:
Object
  • Object
show all
Defined in:
lib/onfido/models/document_breakdown.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentBreakdown

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
122
123
124
125
126
127
 
# File 'lib/onfido/models/document_breakdown.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentBreakdown` 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 `Onfido::DocumentBreakdown`. 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?(:'data_comparison')
    self.data_comparison = attributes[:'data_comparison']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#age_validation ⇒ Object

Returns the value of attribute age_validation.



32
33
34
 
# File 'lib/onfido/models/document_breakdown.rb', line 32

def age_validation
  @age_validation
end

#compromised_document ⇒ Object

Returns the value of attribute compromised_document.



30
31
32
 
# File 'lib/onfido/models/document_breakdown.rb', line 30

def compromised_document
  @compromised_document
end

#data_comparison ⇒ Object

Returns the value of attribute data_comparison.



18
19
20
 
# File 'lib/onfido/models/document_breakdown.rb', line 18

def data_comparison
  @data_comparison
end

#data_consistency ⇒ Object

Returns the value of attribute data_consistency.



26
27
28
 
# File 'lib/onfido/models/document_breakdown.rb', line 26

def data_consistency
  @data_consistency
end

#data_validation ⇒ Object

Returns the value of attribute data_validation.



20
21
22
 
# File 'lib/onfido/models/document_breakdown.rb', line 20

def data_validation
  @data_validation
end

#image_integrity ⇒ Object

Returns the value of attribute image_integrity.



22
23
24
 
# File 'lib/onfido/models/document_breakdown.rb', line 22

def image_integrity
  @image_integrity
end

#issuing_authority ⇒ Object

Returns the value of attribute issuing_authority.



34
35
36
 
# File 'lib/onfido/models/document_breakdown.rb', line 34

def issuing_authority
  @issuing_authority
end

#police_record ⇒ Object

Returns the value of attribute police_record.



28
29
30
 
# File 'lib/onfido/models/document_breakdown.rb', line 28

def police_record
  @police_record
end

#visual_authenticity ⇒ Object

Returns the value of attribute visual_authenticity.



24
25
26
 
# File 'lib/onfido/models/document_breakdown.rb', line 24

def visual_authenticity
  @visual_authenticity
end

Class Method Details

._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



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
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/onfido/models/document_breakdown.rb', line 199

def self._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 = Onfido.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/onfido/models/document_breakdown.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/onfido/models/document_breakdown.rb', line 37

def self.attribute_map
  {
    :'data_comparison' => :'data_comparison',
    :'data_validation' => :'data_validation',
    :'image_integrity' => :'image_integrity',
    :'visual_authenticity' => :'visual_authenticity',
    :'data_consistency' => :'data_consistency',
    :'police_record' => :'police_record',
    :'compromised_document' => :'compromised_document',
    :'age_validation' => :'age_validation',
    :'issuing_authority' => :'issuing_authority'
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/onfido/models/document_breakdown.rb', line 175

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/onfido/models/document_breakdown.rb', line 72

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/onfido/models/document_breakdown.rb', line 57

def self.openapi_types
  {
    :'data_comparison' => :'DocumentBreakdownDataComparison',
    :'data_validation' => :'DocumentBreakdownDataValidation',
    :'image_integrity' => :'DocumentBreakdownImageIntegrity',
    :'visual_authenticity' => :'DocumentBreakdownVisualAuthenticity',
    :'data_consistency' => :'DocumentBreakdownDataConsistency',
    :'police_record' => :'DocumentBreakdownPoliceRecord',
    :'compromised_document' => :'DocumentBreakdownCompromisedDocument',
    :'age_validation' => :'DocumentBreakdownAgeValidation',
    :'issuing_authority' => :'DocumentBreakdownIssuingAuthority'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/onfido/models/document_breakdown.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_comparison == o.data_comparison &&
      data_validation == o.data_validation &&
      image_integrity == o.image_integrity &&
      visual_authenticity == o.visual_authenticity &&
      data_consistency == o.data_consistency &&
      police_record == o.police_record &&
      compromised_document == o.compromised_document &&
      age_validation == o.age_validation &&
      issuing_authority == o.issuing_authority
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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/onfido/models/document_breakdown.rb', line 270

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/onfido/models/document_breakdown.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/onfido/models/document_breakdown.rb', line 168

def hash
  [data_comparison, data_validation, image_integrity, visual_authenticity, data_consistency, police_record, compromised_document, age_validation, issuing_authority].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



131
132
133
134
135
 
# File 'lib/onfido/models/document_breakdown.rb', line 131

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



246
247
248
 
# File 'lib/onfido/models/document_breakdown.rb', line 246

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/onfido/models/document_breakdown.rb', line 252

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



240
241
242
 
# File 'lib/onfido/models/document_breakdown.rb', line 240

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



139
140
141
142
 
# File 'lib/onfido/models/document_breakdown.rb', line 139

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end