Class: UnitOpenapiRubySdk::CreateOfficer

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOfficer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'phone')
    self.phone = attributes[:'phone']
  else
    self.phone = nil
  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']
  else
    self.address = nil
  end

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

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

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

  if attributes.key?(:'occupation')
    self.occupation = attributes[:'occupation']
  else
    self.occupation = nil
  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

#addressObject

Returns the value of attribute address.



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

def address
  @address
end

#annual_incomeObject

Returns the value of attribute annual_income.



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

def annual_income
  @annual_income
end

#date_of_birthObject

Returns the value of attribute date_of_birth.



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

def date_of_birth
  @date_of_birth
end

#emailObject

Returns the value of attribute email.



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

def email
  @email
end

#evaluation_paramsObject

Returns the value of attribute evaluation_params.



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

def evaluation_params
  @evaluation_params
end

#full_nameObject

Returns the value of attribute full_name.



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

def full_name
  @full_name
end

#matricula_consularObject

Returns the value of attribute matricula_consular.



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

def matricula_consular
  @matricula_consular
end

#nationalityObject

Returns the value of attribute nationality.



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

def nationality
  @nationality
end

#occupationObject

Returns the value of attribute occupation.



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

def occupation
  @occupation
end

#passportObject

Returns the value of attribute passport.



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

def passport
  @passport
end

#phoneObject

Returns the value of attribute phone.



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

def phone
  @phone
end

#source_of_incomeObject

Returns the value of attribute source_of_income.



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

def source_of_income
  @source_of_income
end

#ssnObject

Returns the value of attribute ssn.



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

def ssn
  @ssn
end

#titleObject

Returns the value of attribute title.



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

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



362
363
364
365
366
367
368
369
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
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 362

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_attributesObject

Returns all the JSON keys this model knows about



89
90
91
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 69

def self.attribute_map
  {
    :'full_name' => :'fullName',
    :'email' => :'email',
    :'phone' => :'phone',
    :'ssn' => :'ssn',
    :'passport' => :'passport',
    :'nationality' => :'nationality',
    :'matricula_consular' => :'matriculaConsular',
    :'address' => :'address',
    :'date_of_birth' => :'dateOfBirth',
    :'title' => :'title',
    :'evaluation_params' => :'EvaluationParams',
    :'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



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

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_nullableObject

List of attributes with nullable: true



114
115
116
117
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 114

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

.openapi_typesObject

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 94

def self.openapi_types
  {
    :'full_name' => :'FullName',
    :'email' => :'String',
    :'phone' => :'Phone',
    :'ssn' => :'String',
    :'passport' => :'String',
    :'nationality' => :'String',
    :'matricula_consular' => :'String',
    :'address' => :'Address',
    :'date_of_birth' => :'Date',
    :'title' => :'String',
    :'evaluation_params' => :'EvaluationParams',
    :'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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 304

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      title == o.title &&
      evaluation_params == o.evaluation_params &&
      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



433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 433

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


325
326
327
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 325

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



331
332
333
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 331

def hash
  [full_name, email, phone, ssn, passport, nationality, matricula_consular, address, date_of_birth, title, evaluation_params, occupation, annual_income, source_of_income].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



409
410
411
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 409

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



415
416
417
418
419
420
421
422
423
424
425
426
427
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 415

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



403
404
405
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 403

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/unit_openapi_ruby_sdk/models/create_officer.rb', line 247

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @full_name.nil?
  return false if @email.nil?
  return false if @phone.nil?
  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 @address.nil?
  return false if @date_of_birth.nil?
  title_validator = EnumAttributeValidator.new('String', ["President", "CEO", "COO", "CFO", "BenefitsAdministrationOfficer", "CIO", "VP", "AVP", "Treasurer", "Secretary", "Controller", "Manager", "Partner", "Member"])
  return false unless title_validator.valid?(@title)
  return false if @occupation.nil?
  true
end