Class: NucleusApi::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/client.rb

Overview

Client Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Client

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
250
251
252
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/nucleus_api/models/client.rb', line 196

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'business_id')
    self.business_id = attributes[:'business_id']
  end

  if attributes.has_key?(:'citizenship_status')
    self.citizenship_status = attributes[:'citizenship_status']
  end

  if attributes.has_key?(:'client_type')
    self.client_type = attributes[:'client_type']
  end

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

  if attributes.has_key?(:'country_of_residence')
    self.country_of_residence = attributes[:'country_of_residence']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

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

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

  if attributes.has_key?(:'employment')
    self.employment = attributes[:'employment']
  end

  if attributes.has_key?(:'firm_name')
    self.firm_name = attributes[:'firm_name']
  end

  if attributes.has_key?(:'firm_type')
    self.firm_type = attributes[:'firm_type']
  end

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'gender')
    self.gender = attributes[:'gender']
  end

  if attributes.has_key?(:'hydro_id')
    self.hydro_id = attributes[:'hydro_id']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'identification_number')
    self.identification_number = attributes[:'identification_number']
  end

  if attributes.has_key?(:'identification_number_type')
    self.identification_number_type = attributes[:'identification_number_type']
  end

  if attributes.has_key?(:'image')
    self.image = attributes[:'image']
  end

  if attributes.has_key?(:'income')
    self.income = attributes[:'income']
  end

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.has_key?(:'is_verified')
    self.is_verified = attributes[:'is_verified']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.has_key?(:'liquid_net_worth')
    self.liquid_net_worth = attributes[:'liquid_net_worth']
  end

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.has_key?(:'middle_name')
    self.middle_name = attributes[:'middle_name']
  end

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

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

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

  if attributes.has_key?(:'suffix')
    self.suffix = attributes[:'suffix']
  end

  if attributes.has_key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.has_key?(:'total_net_worth')
    self.total_net_worth = attributes[:'total_net_worth']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end

  if attributes.has_key?(:'username')
    self.username = attributes[:'username']
  end
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



18
19
20
 
# File 'lib/nucleus_api/models/client.rb', line 18

def address
  @address
end

#business_id ⇒ Object

business_id



21
22
23
 
# File 'lib/nucleus_api/models/client.rb', line 21

def business_id
  @business_id
end

#citizenship_status ⇒ Object

citizenshipStatus



24
25
26
 
# File 'lib/nucleus_api/models/client.rb', line 24

def citizenship_status
  @citizenship_status
end

#client_type ⇒ Object

clientTypeId



27
28
29
 
# File 'lib/nucleus_api/models/client.rb', line 27

def client_type
  @client_type
end

#country_of_citizenship ⇒ Object

countryOfCitizenship



30
31
32
 
# File 'lib/nucleus_api/models/client.rb', line 30

def country_of_citizenship
  @country_of_citizenship
end

#country_of_residence ⇒ Object

countryOfResidence



33
34
35
 
# File 'lib/nucleus_api/models/client.rb', line 33

def country_of_residence
  @country_of_residence
end

#create_date ⇒ Object

Returns the value of attribute create_date.



35
36
37
 
# File 'lib/nucleus_api/models/client.rb', line 35

def create_date
  @create_date
end

#date_of_birth ⇒ Object

dateOfBirth



38
39
40
 
# File 'lib/nucleus_api/models/client.rb', line 38

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

email



41
42
43
 
# File 'lib/nucleus_api/models/client.rb', line 41

def email
  @email
end

#employment ⇒ Object

Returns the value of attribute employment.



43
44
45
 
# File 'lib/nucleus_api/models/client.rb', line 43

def employment
  @employment
end

#firm_name ⇒ Object

firmName



46
47
48
 
# File 'lib/nucleus_api/models/client.rb', line 46

def firm_name
  @firm_name
end

#firm_type ⇒ Object

firmType



49
50
51
 
# File 'lib/nucleus_api/models/client.rb', line 49

def firm_type
  @firm_type
end

#first_name ⇒ Object

firstName



52
53
54
 
# File 'lib/nucleus_api/models/client.rb', line 52

def first_name
  @first_name
end

#gender ⇒ Object

gender



55
56
57
 
# File 'lib/nucleus_api/models/client.rb', line 55

def gender
  @gender
end

#hydro_id ⇒ Object

hydroId



58
59
60
 
# File 'lib/nucleus_api/models/client.rb', line 58

def hydro_id
  @hydro_id
end

#id ⇒ Object

Returns the value of attribute id.



60
61
62
 
# File 'lib/nucleus_api/models/client.rb', line 60

def id
  @id
end

#identification_number ⇒ Object

identificationNumber



63
64
65
 
# File 'lib/nucleus_api/models/client.rb', line 63

def identification_number
  @identification_number
end

#identification_number_type ⇒ Object

identificationNumberType



66
67
68
 
# File 'lib/nucleus_api/models/client.rb', line 66

def identification_number_type
  @identification_number_type
end

#image ⇒ Object

image



69
70
71
 
# File 'lib/nucleus_api/models/client.rb', line 69

def image
  @image
end

#income ⇒ Object

income



72
73
74
 
# File 'lib/nucleus_api/models/client.rb', line 72

def income
  @income
end

#is_active ⇒ Object

isActive



75
76
77
 
# File 'lib/nucleus_api/models/client.rb', line 75

def is_active
  @is_active
end

#is_verified ⇒ Object

isVerified



78
79
80
 
# File 'lib/nucleus_api/models/client.rb', line 78

def is_verified
  @is_verified
end

#last_name ⇒ Object

last_name



81
82
83
 
# File 'lib/nucleus_api/models/client.rb', line 81

def last_name
  @last_name
end

#liquid_net_worth ⇒ Object

liquidNetWorth



84
85
86
 
# File 'lib/nucleus_api/models/client.rb', line 84

def liquid_net_worth
  @liquid_net_worth
end

#metadata ⇒ Object

metadata



87
88
89
 
# File 'lib/nucleus_api/models/client.rb', line 87

def metadata
  @metadata
end

#middle_name ⇒ Object

middleName



90
91
92
 
# File 'lib/nucleus_api/models/client.rb', line 90

def middle_name
  @middle_name
end

#phone_number ⇒ Object

phoneNumber



93
94
95
 
# File 'lib/nucleus_api/models/client.rb', line 93

def phone_number
  @phone_number
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



95
96
97
 
# File 'lib/nucleus_api/models/client.rb', line 95

def secondary_id
  @secondary_id
end

#status ⇒ Object

status



98
99
100
 
# File 'lib/nucleus_api/models/client.rb', line 98

def status
  @status
end

#suffix ⇒ Object

suffix



101
102
103
 
# File 'lib/nucleus_api/models/client.rb', line 101

def suffix
  @suffix
end

#title ⇒ Object

title



104
105
106
 
# File 'lib/nucleus_api/models/client.rb', line 104

def title
  @title
end

#total_net_worth ⇒ Object

totalNetWorth



107
108
109
 
# File 'lib/nucleus_api/models/client.rb', line 107

def total_net_worth
  @total_net_worth
end

#update_date ⇒ Object

Returns the value of attribute update_date.



109
110
111
 
# File 'lib/nucleus_api/models/client.rb', line 109

def update_date
  @update_date
end

#username ⇒ Object

username



112
113
114
 
# File 'lib/nucleus_api/models/client.rb', line 112

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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/nucleus_api/models/client.rb', line 115

def self.attribute_map
  {
    :'address' => :'address',
    :'business_id' => :'business_id',
    :'citizenship_status' => :'citizenship_status',
    :'client_type' => :'client_type',
    :'country_of_citizenship' => :'country_of_citizenship',
    :'country_of_residence' => :'country_of_residence',
    :'create_date' => :'create_date',
    :'date_of_birth' => :'date_of_birth',
    :'email' => :'email',
    :'employment' => :'employment',
    :'firm_name' => :'firm_name',
    :'firm_type' => :'firm_type',
    :'first_name' => :'first_name',
    :'gender' => :'gender',
    :'hydro_id' => :'hydro_id',
    :'id' => :'id',
    :'identification_number' => :'identification_number',
    :'identification_number_type' => :'identification_number_type',
    :'image' => :'image',
    :'income' => :'income',
    :'is_active' => :'is_active',
    :'is_verified' => :'is_verified',
    :'last_name' => :'last_name',
    :'liquid_net_worth' => :'liquid_net_worth',
    :'metadata' => :'metadata',
    :'middle_name' => :'middle_name',
    :'phone_number' => :'phone_number',
    :'secondary_id' => :'secondary_id',
    :'status' => :'status',
    :'suffix' => :'suffix',
    :'title' => :'title',
    :'total_net_worth' => :'total_net_worth',
    :'update_date' => :'update_date',
    :'username' => :'username'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/nucleus_api/models/client.rb', line 155

def self.swagger_types
  {
    :'address' => :'Array<ClientAddress>',
    :'business_id' => :'String',
    :'citizenship_status' => :'String',
    :'client_type' => :'String',
    :'country_of_citizenship' => :'Array<String>',
    :'country_of_residence' => :'String',
    :'create_date' => :'DateTime',
    :'date_of_birth' => :'String',
    :'email' => :'String',
    :'employment' => :'Employment',
    :'firm_name' => :'String',
    :'firm_type' => :'String',
    :'first_name' => :'String',
    :'gender' => :'String',
    :'hydro_id' => :'String',
    :'id' => :'String',
    :'identification_number' => :'String',
    :'identification_number_type' => :'String',
    :'image' => :'String',
    :'income' => :'Integer',
    :'is_active' => :'BOOLEAN',
    :'is_verified' => :'BOOLEAN',
    :'last_name' => :'String',
    :'liquid_net_worth' => :'Float',
    :'metadata' => :'Hash<String, String>',
    :'middle_name' => :'String',
    :'phone_number' => :'String',
    :'secondary_id' => :'String',
    :'status' => :'String',
    :'suffix' => :'String',
    :'title' => :'String',
    :'total_net_worth' => :'Float',
    :'update_date' => :'DateTime',
    :'username' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/nucleus_api/models/client.rb', line 370

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      business_id == o.business_id &&
      citizenship_status == o.citizenship_status &&
      client_type == o.client_type &&
      country_of_citizenship == o.country_of_citizenship &&
      country_of_residence == o.country_of_residence &&
      create_date == o.create_date &&
      date_of_birth == o.date_of_birth &&
      email == o.email &&
      employment == o.employment &&
      firm_name == o.firm_name &&
      firm_type == o.firm_type &&
      first_name == o.first_name &&
      gender == o.gender &&
      hydro_id == o.hydro_id &&
      id == o.id &&
      identification_number == o.identification_number &&
      identification_number_type == o.identification_number_type &&
      image == o.image &&
      income == o.income &&
      is_active == o.is_active &&
      is_verified == o.is_verified &&
      last_name == o.last_name &&
      liquid_net_worth == o.liquid_net_worth &&
      metadata == o.metadata &&
      middle_name == o.middle_name &&
      phone_number == o.phone_number &&
      secondary_id == o.secondary_id &&
      status == o.status &&
      suffix == o.suffix &&
      title == o.title &&
      total_net_worth == o.total_net_worth &&
      update_date == o.update_date &&
      username == o.username
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/nucleus_api/models/client.rb', line 443

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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
    temp_model = NucleusApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/nucleus_api/models/client.rb', line 509

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

#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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/nucleus_api/models/client.rb', line 424

def build_from_hash(attributes)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


411
412
413
 
# File 'lib/nucleus_api/models/client.rb', line 411

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



417
418
419
 
# File 'lib/nucleus_api/models/client.rb', line 417

def hash
  [address, business_id, citizenship_status, client_type, country_of_citizenship, country_of_residence, create_date, date_of_birth, email, employment, firm_name, firm_type, first_name, gender, hydro_id, id, identification_number, identification_number_type, image, income, is_active, is_verified, last_name, liquid_net_worth, metadata, middle_name, phone_number, secondary_id, status, suffix, title, total_net_worth, update_date, username].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



347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/nucleus_api/models/client.rb', line 347

def list_invalid_properties
  invalid_properties = Array.new
  if @client_type.nil?
    invalid_properties.push('invalid value for "client_type", client_type cannot be nil.')
  end

  if @username.nil?
    invalid_properties.push('invalid value for "username", username cannot be nil.')
  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



490
491
492
 
# File 'lib/nucleus_api/models/client.rb', line 490

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



496
497
498
499
500
501
502
503
 
# File 'lib/nucleus_api/models/client.rb', line 496

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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



484
485
486
 
# File 'lib/nucleus_api/models/client.rb', line 484

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



362
363
364
365
366
 
# File 'lib/nucleus_api/models/client.rb', line 362

def valid?
  return false if @client_type.nil?
  return false if @username.nil?
  true
end