Class: Onfido::Applicant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Applicant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



112
113
114
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/onfido/models/applicant.rb', line 112

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

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

  if attributes.key?(:'id_numbers')
    if (value = attributes[:'id_numbers']).is_a?(Array)
      self.id_numbers = value
    end
  end

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

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



49
50
51
 
# File 'lib/onfido/models/applicant.rb', line 49

def address
  @address
end

#created_at ⇒ Object

The date and time when this applicant was created.



39
40
41
 
# File 'lib/onfido/models/applicant.rb', line 39

def created_at
  @created_at
end

#delete_at ⇒ Object

The date and time when this applicant is scheduled to be deleted.



42
43
44
 
# File 'lib/onfido/models/applicant.rb', line 42

def delete_at
  @delete_at
end

#dob ⇒ Object

The applicant’s date of birth



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

def dob
  @dob
end

#email ⇒ Object

The applicant’s email address. Required if doing a US check, or a UK check for which ‘applicant_provides_data` is `true`.



19
20
21
 
# File 'lib/onfido/models/applicant.rb', line 19

def email
  @email
end

#first_name ⇒ Object

The applicant’s first name



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

def first_name
  @first_name
end

#href ⇒ Object

The uri of this resource.



45
46
47
 
# File 'lib/onfido/models/applicant.rb', line 45

def href
  @href
end

#id ⇒ Object

The unique identifier for the applicant.



36
37
38
 
# File 'lib/onfido/models/applicant.rb', line 36

def id
  @id
end

#id_numbers ⇒ Object

Returns the value of attribute id_numbers.



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

def id_numbers
  @id_numbers
end

#last_name ⇒ Object

The applicant’s surname



33
34
35
 
# File 'lib/onfido/models/applicant.rb', line 33

def last_name
  @last_name
end

#location ⇒ Object

Returns the value of attribute location.



51
52
53
 
# File 'lib/onfido/models/applicant.rb', line 51

def location
  @location
end

#phone_number ⇒ Object

The applicant’s phone number



27
28
29
 
# File 'lib/onfido/models/applicant.rb', line 27

def phone_number
  @phone_number
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



47
48
49
 
# File 'lib/onfido/models/applicant.rb', line 47

def sandbox
  @sandbox
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/onfido/models/applicant.rb', line 303

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'email' => :'email',
    :'dob' => :'dob',
    :'id_numbers' => :'id_numbers',
    :'phone_number' => :'phone_number',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'delete_at' => :'delete_at',
    :'href' => :'href',
    :'sandbox' => :'sandbox',
    :'address' => :'address',
    :'location' => :'location'
  }
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/onfido/models/applicant.rb', line 279

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
108
 
# File 'lib/onfido/models/applicant.rb', line 103

def self.openapi_all_of
  [
  :'ApplicantResponse',
  :'ApplicantShared'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/onfido/models/applicant.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/onfido/models/applicant.rb', line 78

def self.openapi_types
  {
    :'email' => :'String',
    :'dob' => :'Date',
    :'id_numbers' => :'Array<IdNumber>',
    :'phone_number' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'delete_at' => :'Time',
    :'href' => :'String',
    :'sandbox' => :'Boolean',
    :'address' => :'Address',
    :'location' => :'Location'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/onfido/models/applicant.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      dob == o.dob &&
      id_numbers == o.id_numbers &&
      phone_number == o.phone_number &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      id == o.id &&
      created_at == o.created_at &&
      delete_at == o.delete_at &&
      href == o.href &&
      sandbox == o.sandbox &&
      address == o.address &&
      location == o.location
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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/onfido/models/applicant.rb', line 374

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


266
267
268
 
# File 'lib/onfido/models/applicant.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/onfido/models/applicant.rb', line 272

def hash
  [email, dob, id_numbers, phone_number, first_name, last_name, id, created_at, delete_at, href, sandbox, address, location].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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/onfido/models/applicant.rb', line 184

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
  if !@first_name.nil? && @first_name !~ pattern
    invalid_properties.push("invalid value for \"first_name\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
  if !@last_name.nil? && @last_name !~ pattern
    invalid_properties.push("invalid value for \"last_name\", must conform to the pattern #{pattern}.")
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id 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



350
351
352
 
# File 'lib/onfido/models/applicant.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/onfido/models/applicant.rb', line 356

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



344
345
346
 
# File 'lib/onfido/models/applicant.rb', line 344

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



206
207
208
209
210
211
212
 
# File 'lib/onfido/models/applicant.rb', line 206

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@first_name.nil? && @first_name !~ Regexp.new(/^[^!#$%*=<>;{}"]*$/)
  return false if !@last_name.nil? && @last_name !~ Regexp.new(/^[^!#$%*=<>;{}"]*$/)
  return false if @id.nil?
  true
end