Class: TrinsicApi::NetherlandsIdinProviderOutput

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

Overview

Exposed properties for the ‘netherlands-idin` 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 = {}) ⇒ NetherlandsIdinProviderOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 101

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Address of the individual.



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

def address
  @address
end

#authority_id ⇒ Object

Unique identifier of the authority that was used to verify the individual. For banks this follows the SWIFT/BIC (Bank Identification Code) format.



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

def authority_id
  @authority_id
end

#authority_name ⇒ Object

Name of the authority that was used to verify the individual.



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

def authority_name
  @authority_name
end

#birth_date ⇒ Object

Date of birth of the individual.



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

def birth_date
  @birth_date
end

#customer_id ⇒ Object

Unique identifier of the customer’s account with the issuing authority. This identifier is generated by each authority and is unique per customer registration, authority, and individual. The identifier should be treated as a unique opaque string.



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

def customer_id
  @customer_id
end

#email ⇒ Object

Email address of the individual.



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

def email
  @email
end

#family_name ⇒ Object

Last/family name of the individual.



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

def family_name
  @family_name
end

#gender ⇒ Object

Gender of the individual. Possible values: - Male - Female - Unknown



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

def gender
  @gender
end

#initials ⇒ Object

Initials of the individual.



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

def initials
  @initials
end

#phone_number ⇒ Object

Phone number of the individual in E164 format.



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

def phone_number
  @phone_number
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/trinsic_api/models/netherlands_idin_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/netherlands_idin_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/netherlands_idin_provider_output.rb', line 50

def self.attribute_map
  {
    :'authority_id' => :'authorityId',
    :'authority_name' => :'authorityName',
    :'customer_id' => :'customerId',
    :'initials' => :'initials',
    :'family_name' => :'familyName',
    :'address' => :'address',
    :'birth_date' => :'birthDate',
    :'gender' => :'gender',
    :'phone_number' => :'phoneNumber',
    :'email' => :'email'
  }
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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 339

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

def self.openapi_nullable
  Set.new([
    :'phone_number',
    :'email'
  ])
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/netherlands_idin_provider_output.rb', line 76

def self.openapi_types
  {
    :'authority_id' => :'String',
    :'authority_name' => :'String',
    :'customer_id' => :'String',
    :'initials' => :'String',
    :'family_name' => :'String',
    :'address' => :'NetherlandsIdinAddress',
    :'birth_date' => :'Date',
    :'gender' => :'String',
    :'phone_number' => :'String',
    :'email' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authority_id == o.authority_id &&
      authority_name == o.authority_name &&
      customer_id == o.customer_id &&
      initials == o.initials &&
      family_name == o.family_name &&
      address == o.address &&
      birth_date == o.birth_date &&
      gender == o.gender &&
      phone_number == o.phone_number &&
      email == o.email
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


326
327
328
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



332
333
334
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 332

def hash
  [authority_id, authority_name, customer_id, initials, family_name, address, birth_date, gender, phone_number, email].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



174
175
176
177
178
179
180
181
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/netherlands_idin_provider_output.rb', line 174

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/trinsic_api/models/netherlands_idin_provider_output.rb', line 361

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @authority_id.nil?
  return false if @authority_name.nil?
  return false if @customer_id.nil?
  return false if @initials.nil?
  return false if @family_name.nil?
  return false if @address.nil?
  return false if @birth_date.nil?
  return false if @gender.nil?
  true
end