Class: Onfido::ApplicantBuilder

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicantBuilder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/onfido/models/applicant_builder.rb', line 94

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#consents ⇒ Object

The applicant’s consents



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

def consents
  @consents
end

#dob ⇒ Object

The applicant’s date of birth



22
23
24
 
# File 'lib/onfido/models/applicant_builder.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_builder.rb', line 19

def email
  @email
end

#first_name ⇒ Object

The applicant’s first name



37
38
39
 
# File 'lib/onfido/models/applicant_builder.rb', line 37

def first_name
  @first_name
end

#id_numbers ⇒ Object

Returns the value of attribute id_numbers.



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

def id_numbers
  @id_numbers
end

#last_name ⇒ Object

The applicant’s surname



40
41
42
 
# File 'lib/onfido/models/applicant_builder.rb', line 40

def last_name
  @last_name
end

#location ⇒ Object

Returns the value of attribute location.



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

def location
  @location
end

#phone_number ⇒ Object

The applicant’s phone number



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

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/onfido/models/applicant_builder.rb', line 274

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



58
59
60
 
# File 'lib/onfido/models/applicant_builder.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.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
55
 
# File 'lib/onfido/models/applicant_builder.rb', line 43

def self.attribute_map
  {
    :'email' => :'email',
    :'dob' => :'dob',
    :'id_numbers' => :'id_numbers',
    :'phone_number' => :'phone_number',
    :'consents' => :'consents',
    :'address' => :'address',
    :'location' => :'location',
    :'first_name' => :'first_name',
    :'last_name' => :'last_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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/onfido/models/applicant_builder.rb', line 250

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)



84
85
86
87
88
89
90
 
# File 'lib/onfido/models/applicant_builder.rb', line 84

def self.openapi_all_of
  [
  :'ApplicantCreate',
  :'ApplicantRequest',
  :'ApplicantShared'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/onfido/models/applicant_builder.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/onfido/models/applicant_builder.rb', line 63

def self.openapi_types
  {
    :'email' => :'String',
    :'dob' => :'Date',
    :'id_numbers' => :'Array<IdNumber>',
    :'phone_number' => :'String',
    :'consents' => :'Array<ApplicantConsentBuilder>',
    :'address' => :'AddressBuilder',
    :'location' => :'LocationBuilder',
    :'first_name' => :'String',
    :'last_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/onfido/models/applicant_builder.rb', line 221

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 &&
      consents == o.consents &&
      address == o.address &&
      location == o.location &&
      first_name == o.first_name &&
      last_name == o.last_name
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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/onfido/models/applicant_builder.rb', line 345

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


237
238
239
 
# File 'lib/onfido/models/applicant_builder.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



243
244
245
 
# File 'lib/onfido/models/applicant_builder.rb', line 243

def hash
  [email, dob, id_numbers, phone_number, consents, address, location, first_name, last_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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/onfido/models/applicant_builder.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @first_name.nil?
    invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
  end

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

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

  pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
  if @last_name !~ pattern
    invalid_properties.push("invalid value for \"last_name\", must conform to the pattern #{pattern}.")
  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



321
322
323
 
# File 'lib/onfido/models/applicant_builder.rb', line 321

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/onfido/models/applicant_builder.rb', line 327

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



315
316
317
 
# File 'lib/onfido/models/applicant_builder.rb', line 315

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



180
181
182
183
184
185
186
187
 
# File 'lib/onfido/models/applicant_builder.rb', line 180

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