Class: TrinsicApi::KenyaNidLookup2ProviderOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb

Overview

Exposed properties for the ‘kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KenyaNidLookup2ProviderOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#citizenship ⇒ Object

Citizenship status as recorded in the IPRS civil registry database. For the Kenya National ID lookup, this value will always be "Kenyan" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider.



35
36
37
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 35

def citizenship
  @citizenship
end

#date_of_birth ⇒ Object

The date of birth of the ID holder as recorded in IPRS.



32
33
34
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 32

def date_of_birth
  @date_of_birth
end

#date_of_issue ⇒ Object

The date the National ID was issued by the National Registration Bureau (NRB).



44
45
46
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 44

def date_of_issue
  @date_of_issue
end

#first_name ⇒ Object

The first name (given name) of the ID holder as recorded in IPRS.



20
21
22
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 20

def first_name
  @first_name
end

#id_number ⇒ Object

The Kenya National ID Number (Nambari ya Kitambulisho). This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is 1 to 9 numeric digits (regex: /^[0-9]1,9$/). This number is assigned upon first registration at age 18 (or upon naturalization for new citizens) and remains constant for life.



38
39
40
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 38

def id_number
  @id_number
end

#other_name ⇒ Object

The other name (middle name) of the ID holder as recorded in IPRS.



26
27
28
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 26

def other_name
  @other_name
end

#place_of_birth ⇒ Object

Place of birth as recorded in Kenya’s civil registry (IPRS). This is structured according to Kenya’s pre-2010 administrative hierarchy (District > Division > Location).



47
48
49
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 47

def place_of_birth
  @place_of_birth
end

#place_of_residence ⇒ Object

Current residence address as registered in IPRS. This represents the address on file at the time of ID registration or last update, structured according to Kenya’s pre-2010 administrative hierarchy (District > Division > Location).



50
51
52
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 50

def place_of_residence
  @place_of_residence
end

#serial_number ⇒ Object

The physical card serial number printed on the Kenya National ID card. This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal).



41
42
43
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 41

def serial_number
  @serial_number
end

#sex ⇒ Object

The sex of the ID holder as recorded on the National ID. Possible values: - Male - Female



29
30
31
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 29

def sex
  @sex
end

#surname ⇒ Object

The surname (family name) of the ID holder as recorded in IPRS.



23
24
25
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 23

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 342

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 = TrinsicApi.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 53

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'surname' => :'surname',
    :'other_name' => :'otherName',
    :'sex' => :'sex',
    :'date_of_birth' => :'dateOfBirth',
    :'citizenship' => :'citizenship',
    :'id_number' => :'idNumber',
    :'serial_number' => :'serialNumber',
    :'date_of_issue' => :'dateOfIssue',
    :'place_of_birth' => :'placeOfBirth',
    :'place_of_residence' => :'placeOfResidence'
  }
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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 318

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 97

def self.openapi_nullable
  Set.new([
    :'other_name',
    :'date_of_birth',
    :'date_of_issue',
    :'place_of_birth',
    :'place_of_residence'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'first_name' => :'String',
    :'surname' => :'String',
    :'other_name' => :'String',
    :'sex' => :'String',
    :'date_of_birth' => :'Date',
    :'citizenship' => :'String',
    :'id_number' => :'String',
    :'serial_number' => :'String',
    :'date_of_issue' => :'Date',
    :'place_of_birth' => :'KenyaNidLookup2Address',
    :'place_of_residence' => :'KenyaNidLookup2Address'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      surname == o.surname &&
      other_name == o.other_name &&
      sex == o.sex &&
      date_of_birth == o.date_of_birth &&
      citizenship == o.citizenship &&
      id_number == o.id_number &&
      serial_number == o.serial_number &&
      date_of_issue == o.date_of_issue &&
      place_of_birth == o.place_of_birth &&
      place_of_residence == o.place_of_residence
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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 413

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


305
306
307
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 311

def hash
  [first_name, surname, other_name, sex, date_of_birth, citizenship, id_number, serial_number, date_of_issue, place_of_birth, place_of_residence].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



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
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 182

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

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

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

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

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

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



389
390
391
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 389

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 395

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



383
384
385
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 383

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



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_provider_output.rb', line 214

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @first_name.nil?
  return false if @surname.nil?
  return false if @sex.nil?
  return false if @citizenship.nil?
  return false if @id_number.nil?
  return false if @serial_number.nil?
  true
end