Class: TrinsicApi::CoteDIvoireNidLookup2ProviderOutput

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

Overview

Exposed properties for the cote-divoire-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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CoteDIvoireNidLookup2ProviderOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 103

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Address as returned from ONECI (National Civil Registry and Identification Office). Format is LOCALITY,COMMUNE: the locality (village, neighborhood, or sous-quartier) followed by the commune. Not a full street address.



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

def address
  @address
end

#date_of_birth ⇒ Object

Date of birth as returned by ONECI (National Civil Registry and Identification Office).



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

def date_of_birth
  @date_of_birth
end

#document_number ⇒ Object

The document's own identifier (printed on the card; often labeled "Immatriculation" on older cards or "Numéro CNI" in post-2020 cards). On older cards this is usually one letter followed by 10 digits. On new cards it appears as 1 or 2 leading letters plus 9 digits.



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

def document_number
  @document_number
end

#family_name ⇒ Object

Family name of the ID holder as returned by ONECI (National Civil Registry and Identification Office).



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

def family_name
  @family_name
end

#full_name ⇒ Object

Full name as returned by ONECI (National Civil Registry and Identification Office).



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

def full_name
  @full_name
end

#given_name ⇒ Object

Given name of the ID holder as returned by ONECI (National Civil Registry and Identification Office).



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

def given_name
  @given_name
end

#national_id_number ⇒ Object

The NNI (Numéro National d'Identification): the person's 11-digit national ID, printed on the back of the new national id card and assigned by ONECI. It is always exactly 11 digits with no letters, and is semi-random, non-repetitive, and does not encode any extra data, such as date of birth, gender, or other readable attributes.



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

def national_id_number
  @national_id_number
end

#nationality ⇒ Object

Nationality as ISO 3166-1 alpha-2 country code (e.g. "CI" for Côte d'Ivoire).



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

def nationality
  @nationality
end

#sex ⇒ Object

Sex of the ID holder as returned by ONECI (National Civil Registry and Identification Office). Possible values: - Male - Female



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

def sex
  @sex
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 47

def self.attribute_map
  {
    :'full_name' => :'fullName',
    :'given_name' => :'givenName',
    :'family_name' => :'familyName',
    :'date_of_birth' => :'dateOfBirth',
    :'sex' => :'sex',
    :'nationality' => :'nationality',
    :'address' => :'address',
    :'document_number' => :'documentNumber',
    :'national_id_number' => :'nationalIdNumber'
  }
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 200

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



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 87

def self.openapi_nullable
  Set.new([
    :'full_name',
    :'given_name',
    :'family_name',
    :'date_of_birth',
    :'sex',
    :'nationality',
    :'address',
    :'document_number',
    :'national_id_number'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 72

def self.openapi_types
  {
    :'full_name' => :'String',
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'date_of_birth' => :'Date',
    :'sex' => :'String',
    :'nationality' => :'String',
    :'address' => :'String',
    :'document_number' => :'String',
    :'national_id_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      full_name == o.full_name &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      date_of_birth == o.date_of_birth &&
      sex == o.sex &&
      nationality == o.nationality &&
      address == o.address &&
      document_number == o.document_number &&
      national_id_number == o.national_id_number
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 193

def hash
  [full_name, given_name, family_name, date_of_birth, sex, nationality, address, document_number, national_id_number].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



156
157
158
159
160
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 156

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 222

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



164
165
166
167
 
# File 'lib/trinsic_api/models/cote_d_ivoire_nid_lookup2_provider_output.rb', line 164

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