Class: UnitOpenapiRubySdk::BeneficialOwner

Inherits:
Object
  • Object
show all
Defined in:
lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeneficialOwner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



34
35
36
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 34

def address
  @address
end

#annual_income ⇒ Object

Returns the value of attribute annual_income.



56
57
58
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 56

def annual_income
  @annual_income
end

#date_of_birth ⇒ Object

Returns the value of attribute date_of_birth.



36
37
38
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 36

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Returns the value of attribute email.



22
23
24
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 22

def email
  @email
end

#evaluation_codes ⇒ Object

Returns the value of attribute evaluation_codes.



52
53
54
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 52

def evaluation_codes
  @evaluation_codes
end

#evaluation_flags ⇒ Object

Returns the value of attribute evaluation_flags.



42
43
44
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 42

def evaluation_flags
  @evaluation_flags
end

#evaluation_id ⇒ Object

Returns the value of attribute evaluation_id.



38
39
40
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 38

def evaluation_id
  @evaluation_id
end

#full_name ⇒ Object

Returns the value of attribute full_name.



20
21
22
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 20

def full_name
  @full_name
end

#id_theft_score ⇒ Object

Returns the value of attribute id_theft_score.



50
51
52
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 50

def id_theft_score
  @id_theft_score
end

#masked_matricula_consular ⇒ Object

Returns the value of attribute masked_matricula_consular.



48
49
50
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 48

def masked_matricula_consular
  @masked_matricula_consular
end

#masked_passport ⇒ Object

Returns the value of attribute masked_passport.



46
47
48
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 46

def masked_passport
  @masked_passport
end

#masked_ssn ⇒ Object

Returns the value of attribute masked_ssn.



44
45
46
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 44

def masked_ssn
  @masked_ssn
end

#matricula_consular ⇒ Object

Returns the value of attribute matricula_consular.



32
33
34
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 32

def matricula_consular
  @matricula_consular
end

#nationality ⇒ Object

Returns the value of attribute nationality.



30
31
32
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 30

def nationality
  @nationality
end

#occupation ⇒ Object

Returns the value of attribute occupation.



54
55
56
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 54

def occupation
  @occupation
end

#passport ⇒ Object

Returns the value of attribute passport.



28
29
30
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 28

def passport
  @passport
end

#percentage ⇒ Object

Returns the value of attribute percentage.



40
41
42
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 40

def percentage
  @percentage
end

#phone ⇒ Object

Returns the value of attribute phone.



24
25
26
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 24

def phone
  @phone
end

#source_of_income ⇒ Object

Returns the value of attribute source_of_income.



58
59
60
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 58

def source_of_income
  @source_of_income
end

#ssn ⇒ Object

Returns the value of attribute ssn.



26
27
28
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 26

def ssn
  @ssn
end

#status ⇒ Object

Returns the value of attribute status.



18
19
20
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 18

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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 424

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 = UnitOpenapiRubySdk.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 83

def self.attribute_map
  {
    :'status' => :'status',
    :'full_name' => :'fullName',
    :'email' => :'email',
    :'phone' => :'phone',
    :'ssn' => :'ssn',
    :'passport' => :'passport',
    :'nationality' => :'nationality',
    :'matricula_consular' => :'matriculaConsular',
    :'address' => :'address',
    :'date_of_birth' => :'dateOfBirth',
    :'evaluation_id' => :'evaluationId',
    :'percentage' => :'percentage',
    :'evaluation_flags' => :'evaluationFlags',
    :'masked_ssn' => :'maskedSSN',
    :'masked_passport' => :'maskedPassport',
    :'masked_matricula_consular' => :'maskedMatriculaConsular',
    :'id_theft_score' => :'idTheftScore',
    :'evaluation_codes' => :'evaluationCodes',
    :'occupation' => :'occupation',
    :'annual_income' => :'annualIncome',
    :'source_of_income' => :'sourceOfIncome'
  }
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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 400

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



142
143
144
145
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 142

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 115

def self.openapi_types
  {
    :'status' => :'String',
    :'full_name' => :'FullName',
    :'email' => :'String',
    :'phone' => :'Phone',
    :'ssn' => :'String',
    :'passport' => :'String',
    :'nationality' => :'String',
    :'matricula_consular' => :'String',
    :'address' => :'Address',
    :'date_of_birth' => :'Date',
    :'evaluation_id' => :'String',
    :'percentage' => :'Integer',
    :'evaluation_flags' => :'Array<String>',
    :'masked_ssn' => :'String',
    :'masked_passport' => :'String',
    :'masked_matricula_consular' => :'String',
    :'id_theft_score' => :'Integer',
    :'evaluation_codes' => :'Array<String>',
    :'occupation' => :'Occupation',
    :'annual_income' => :'AnnualIncome',
    :'source_of_income' => :'SourceOfIncome'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      full_name == o.full_name &&
      email == o.email &&
      phone == o.phone &&
      ssn == o.ssn &&
      passport == o.passport &&
      nationality == o.nationality &&
      matricula_consular == o.matricula_consular &&
      address == o.address &&
      date_of_birth == o.date_of_birth &&
      evaluation_id == o.evaluation_id &&
      percentage == o.percentage &&
      evaluation_flags == o.evaluation_flags &&
      masked_ssn == o.masked_ssn &&
      masked_passport == o.masked_passport &&
      masked_matricula_consular == o.masked_matricula_consular &&
      id_theft_score == o.id_theft_score &&
      evaluation_codes == o.evaluation_codes &&
      occupation == o.occupation &&
      annual_income == o.annual_income &&
      source_of_income == o.source_of_income
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



495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 495

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


387
388
389
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 387

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



393
394
395
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 393

def hash
  [status, full_name, email, phone, ssn, passport, nationality, matricula_consular, address, date_of_birth, evaluation_id, percentage, evaluation_flags, masked_ssn, masked_passport, masked_matricula_consular, id_theft_score, evaluation_codes, occupation, annual_income, source_of_income].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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 253

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d{9}$/)
  if !@ssn.nil? && @ssn !~ pattern
    invalid_properties.push("invalid value for \"ssn\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^(A(D|E|F|G|I|L|M|N|O|R|S|T|Q|U|W|X|Z)|B(A|B|D|E|F|G|H|I|J|L|M|N|O|Q|R|S|T|V|W|Y|Z)|C(A|C|D|F|G|H|I|K|L|M|N|O|R|U|V|W|X|Y|Z)|D(E|J|K|M|O|Z)|E(C|E|G|H|R|S|T)|F(I|J|K|M|O|R)|G(A|B|D|E|F|G|H|I|L|M|N|P|Q|R|S|T|U|W|Y)|H(K|M|N|R|T|U)|I(D|E|Q|L|M|N|O|R|S|T)|J(E|M|O|P)|K(E|G|H|I|M|N|P|R|W|Y|Z)|L(A|B|C|I|K|R|S|T|U|V|Y)|M(A|C|D|E|F|G|H|K|L|M|N|O|Q|P|R|S|T|U|V|W|X|Y|Z)|N(A|C|E|F|G|I|L|O|P|R|U|Z)|OM|P(A|E|F|G|H|K|L|M|N|R|S|T|W|Y)|QA|R(E|O|S|U|W)|S(A|B|C|D|E|G|H|I|J|K|L|M|N|O|R|T|V|X|Y|Z)|T(C|D|F|G|H|J|K|L|M|N|O|R|T|V|W|Z)|U(A|G|M|S|Y|Z)|V(A|C|E|G|I|N|U)|W(F|S)|XK|Y(E|T)|Z(A|M|W))$/)
  if !@nationality.nil? && @nationality !~ pattern
    invalid_properties.push("invalid value for \"nationality\", must conform to the pattern #{pattern}.")
  end

  if !@percentage.nil? && @percentage > 100
    invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
  end

  if !@percentage.nil? && @percentage < 0
    invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
  end

  pattern = Regexp.new(/^\*{5}\d{4}$/)
  if !@masked_ssn.nil? && @masked_ssn !~ pattern
    invalid_properties.push("invalid value for \"masked_ssn\", must conform to the pattern #{pattern}.")
  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



471
472
473
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 471

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



477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 477

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



465
466
467
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 465

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



284
285
286
287
288
289
290
291
292
 
# File 'lib/unit_openapi_ruby_sdk/models/beneficial_owner.rb', line 284

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@ssn.nil? && @ssn !~ Regexp.new(/^\d{9}$/)
  return false if !@nationality.nil? && @nationality !~ Regexp.new(/^(A(D|E|F|G|I|L|M|N|O|R|S|T|Q|U|W|X|Z)|B(A|B|D|E|F|G|H|I|J|L|M|N|O|Q|R|S|T|V|W|Y|Z)|C(A|C|D|F|G|H|I|K|L|M|N|O|R|U|V|W|X|Y|Z)|D(E|J|K|M|O|Z)|E(C|E|G|H|R|S|T)|F(I|J|K|M|O|R)|G(A|B|D|E|F|G|H|I|L|M|N|P|Q|R|S|T|U|W|Y)|H(K|M|N|R|T|U)|I(D|E|Q|L|M|N|O|R|S|T)|J(E|M|O|P)|K(E|G|H|I|M|N|P|R|W|Y|Z)|L(A|B|C|I|K|R|S|T|U|V|Y)|M(A|C|D|E|F|G|H|K|L|M|N|O|Q|P|R|S|T|U|V|W|X|Y|Z)|N(A|C|E|F|G|I|L|O|P|R|U|Z)|OM|P(A|E|F|G|H|K|L|M|N|R|S|T|W|Y)|QA|R(E|O|S|U|W)|S(A|B|C|D|E|G|H|I|J|K|L|M|N|O|R|T|V|X|Y|Z)|T(C|D|F|G|H|J|K|L|M|N|O|R|T|V|W|Z)|U(A|G|M|S|Y|Z)|V(A|C|E|G|I|N|U)|W(F|S)|XK|Y(E|T)|Z(A|M|W))$/)
  return false if !@percentage.nil? && @percentage > 100
  return false if !@percentage.nil? && @percentage < 0
  return false if !@masked_ssn.nil? && @masked_ssn !~ Regexp.new(/^\*{5}\d{4}$/)
  true
end