Class: TrinsicApi::ColombiaCcProviderOutput

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

Overview

Exposed properties for the colombia-cc-lookup 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 = {}) ⇒ ColombiaCcProviderOutput

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
 
# File 'lib/trinsic_api/models/colombia_cc_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::ColombiaCcProviderOutput` 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::ColombiaCcProviderOutput`. 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?(:'is_alive')
    self.is_alive = attributes[:'is_alive']
  end

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

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

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

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

Instance Attribute Details

#array_name ⇒ Object

All names as they appear on the CC, as an array of strings. Format: - Order follows the civil registry: typically family name(s) first, then given name(s).



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

def array_name
  @array_name
end

#date_of_birth ⇒ Object

Date of birth as recorded in the civil registry (Registraduría Nacional).



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

def date_of_birth
  @date_of_birth
end

#document_number ⇒ Object

The Cédula de Ciudadanía (CC) document number. This is the unique identifier assigned by the Registraduría Nacional when the person is first issued a CC. It does not change when the person renews or receives a new physical card; it remains the same for the individual for life. Cédulas issued after 2004 use the NUIP (Número Único de Identificación Personal), which is 10 digits. Older documents may have fewer than 10 digits and are still valid.



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

def document_number
  @document_number
end

#expedition_date ⇒ Object

Date the CC was issued (fecha de expedición). Format: - yyyy-MM-dd



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

def expedition_date
  @expedition_date
end

#expedition_place ⇒ Object

Place where the CC was issued (lugar de expedición): municipality and department as recorded by the Registraduría Nacional.



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

def expedition_place
  @expedition_place
end

#family_name ⇒ Object

Family name(s) of the holder as they appear on the CC. Space-separated when both paternal and maternal family names are present.



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

def family_name
  @family_name
end

#full_name ⇒ Object

Full name as it appears on the CC.



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

def full_name
  @full_name
end

#given_name ⇒ Object

Given name(s) of the holder as they appear on the CC.



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

def given_name
  @given_name
end

#is_alive ⇒ Object

Whether the person is reported as alive in Colombia's official civil registry (Registraduría Nacional). Used to detect identity fraud when the holder is deceased.



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

def is_alive
  @is_alive
end

#sex ⇒ Object

Sex of the holder as recorded in the civil registry (Registraduría Nacional). Possible values: - Male - Female - Unknown (when the sex is not recorded or cannot be confidently determined)



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

def sex
  @sex
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 50

def self.attribute_map
  {
    :'full_name' => :'fullName',
    :'given_name' => :'givenName',
    :'family_name' => :'familyName',
    :'date_of_birth' => :'dateOfBirth',
    :'sex' => :'sex',
    :'is_alive' => :'isAlive',
    :'document_number' => :'documentNumber',
    :'expedition_date' => :'expeditionDate',
    :'expedition_place' => :'expeditionPlace',
    :'array_name' => :'arrayName'
  }
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 213

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 92

def self.openapi_nullable
  Set.new([
    :'full_name',
    :'given_name',
    :'family_name',
    :'date_of_birth',
    :'sex',
    :'is_alive',
    :'document_number',
    :'expedition_date',
    :'expedition_place',
    :'array_name'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 76

def self.openapi_types
  {
    :'full_name' => :'String',
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'date_of_birth' => :'Date',
    :'sex' => :'String',
    :'is_alive' => :'Boolean',
    :'document_number' => :'String',
    :'expedition_date' => :'Date',
    :'expedition_place' => :'ColombiaExpeditionPlace',
    :'array_name' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 183

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 &&
      is_alive == o.is_alive &&
      document_number == o.document_number &&
      expedition_date == o.expedition_date &&
      expedition_place == o.expedition_place &&
      array_name == o.array_name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 206

def hash
  [full_name, given_name, family_name, date_of_birth, sex, is_alive, document_number, expedition_date, expedition_place, array_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



168
169
170
171
172
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 168

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 235

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



176
177
178
179
 
# File 'lib/trinsic_api/models/colombia_cc_provider_output.rb', line 176

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