Class: TrinsicApi::KenyaNidLookup2Address

Inherits:
ApiModelBase show all
Defined in:
lib/trinsic_api/models/kenya_nid_lookup2_address.rb

Overview

Represents a Kenya address as stored in the IPRS (Integrated Population Registration System) database. The structure reflects the pre-2010 provincial administration system: District > Division > Location. Since the 2010 constitutional change to counties, these legacy administrative divisions are still maintained in IPRS records for historical continuity. The raw address from IPRS is a newline-separated string with labeled administrative components. Example format: “‘ P O BOX 41842 NAIROBI PARLIAMENT BUILDINGS LOCATION - CITY SQUARE DIVISION - CENTRAL DISTRICT - NAIROBI “` The first lines contain informal address details (village, P.O. Box) while the suffixed lines contain official administrative designations prefixed with labels like "LOCATION -", "DIVISION -", "DISTRICT -".

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ KenyaNidLookup2Address

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

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

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

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

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

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

Instance Attribute Details

#additional_lines ⇒ Object

Additional address lines that appear before the structured administrative parts. May include P.O. Box (format: "P O BOX [number] [location]"), village names, estate names, or other informal locality information.



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

def additional_lines
  @additional_lines
end

#district ⇒ Object

The district where the person resides. This is the highest level of the pre-2010 administrative hierarchy stored in IPRS. Districts were the primary administrative units under Kenya’s provincial system before the change to counties in 2010. Districts roughly correspond to sub-counties in the current administrative structure.



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

def district
  @district
end

#division ⇒ Object

The division within the district. This is the second level of the pre-2010 administrative hierarchy. Divisions were administrative units between districts and locations.



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

def division
  @division
end

#location ⇒ Object

The location within the division. This is the third level of the pre-2010 administrative hierarchy. Locations were the smallest administrative units.



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

def location
  @location
end

#raw ⇒ Object

The raw, unparsed address string as returned from IPRS (Integrated Population Registration System). This preserves the original newline-separated format containing both informal address components (village, P.O. Box) and labeled administrative divisions (LOCATION, DIVISION, DISTRICT).



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

def raw
  @raw
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 35

def self.attribute_map
  {
    :'district' => :'district',
    :'division' => :'division',
    :'location' => :'location',
    :'additional_lines' => :'additionalLines',
    :'raw' => :'raw'
  }
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 158

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



67
68
69
70
71
72
73
74
75
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 67

def self.openapi_nullable
  Set.new([
    :'district',
    :'division',
    :'location',
    :'additional_lines',
    :'raw'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 56

def self.openapi_types
  {
    :'district' => :'String',
    :'division' => :'String',
    :'location' => :'String',
    :'additional_lines' => :'Array<String>',
    :'raw' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
140
141
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      district == o.district &&
      division == o.division &&
      location == o.location &&
      additional_lines == o.additional_lines &&
      raw == o.raw
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 151

def hash
  [district, division, location, additional_lines, raw].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



118
119
120
121
122
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 118

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 180

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



126
127
128
129
 
# File 'lib/trinsic_api/models/kenya_nid_lookup2_address.rb', line 126

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