Class: DealMakerAPI::PostInvestorProfilesJoints

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/models/post_investor_profiles_joints.rb

Overview

Create new joint investor profile

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInvestorProfilesJoints

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 206

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ca_accredited_investorObject

The Canadian accredited investor information.



26
27
28
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 26

def ca_accredited_investor
  @ca_accredited_investor
end

#cityObject

The city of the primary holder (required).



47
48
49
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 47

def city
  @city
end

#date_of_birthObject

The date of birth of the primary holder (required).



56
57
58
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 56

def date_of_birth
  @date_of_birth
end

#emailObject

User email which is associated with investor profile.



20
21
22
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 20

def email
  @email
end

#first_nameObject

The first name of the primary holder (required).



32
33
34
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 32

def first_name
  @first_name
end

#incomeObject

The income of the primary holder.



65
66
67
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 65

def income
  @income
end

#joint_holder_cityObject

The city of the joint holder (required).



89
90
91
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 89

def joint_holder_city
  @joint_holder_city
end

#joint_holder_date_of_birthObject

The date of birth of the joint holder (required).



98
99
100
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 98

def joint_holder_date_of_birth
  @joint_holder_date_of_birth
end

#joint_holder_first_nameObject

The first name of the joint holder (required).



74
75
76
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 74

def joint_holder_first_name
  @joint_holder_first_name
end

#joint_holder_last_nameObject

The last name of the joint holder (required).



77
78
79
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 77

def joint_holder_last_name
  @joint_holder_last_name
end

#joint_holder_postal_codeObject

The postal code or zipcode of the joint holder (required).



95
96
97
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 95

def joint_holder_postal_code
  @joint_holder_postal_code
end

#joint_holder_regionObject

The region or state of the joint holder (required).



92
93
94
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 92

def joint_holder_region
  @joint_holder_region
end

#joint_holder_street_addressObject

The street address of the joint holder (required).



83
84
85
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 83

def joint_holder_street_address
  @joint_holder_street_address
end

#joint_holder_suffixObject

The suffix of the joint holder.



80
81
82
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 80

def joint_holder_suffix
  @joint_holder_suffix
end

#joint_holder_taxpayer_idObject

The taxpayer identification number of the joint holder (required).



101
102
103
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 101

def joint_holder_taxpayer_id
  @joint_holder_taxpayer_id
end

#joint_holder_unit2Object

The street address line 2 of the joint holder.



86
87
88
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 86

def joint_holder_unit2
  @joint_holder_unit2
end

#joint_typeObject

The types of joint investor.



29
30
31
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 29

def joint_type
  @joint_type
end

#last_nameObject

The last name of the primary holder (required).



35
36
37
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 35

def last_name
  @last_name
end

#net_worthObject

The net worth of the primary holder.



68
69
70
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 68

def net_worth
  @net_worth
end

#phone_numberObject

The phone number of the primary holder (required).



62
63
64
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 62

def phone_number
  @phone_number
end

#postal_codeObject

The postal code or zipcode of the primary holder (required).



53
54
55
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 53

def postal_code
  @postal_code
end

#reg_cf_prior_offerings_amountObject

The prior offerings amount of the primary holder.



71
72
73
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 71

def reg_cf_prior_offerings_amount
  @reg_cf_prior_offerings_amount
end

#regionObject

The region or State of the primary holder (required).



50
51
52
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 50

def region
  @region
end

#street_addressObject

The street address of the primary holder (required).



41
42
43
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 41

def street_address
  @street_address
end

#suffixObject

The suffix of the primary holder.



38
39
40
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 38

def suffix
  @suffix
end

#taxpayer_idObject

The taxpayer identification number of the primary holder (required).



59
60
61
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 59

def taxpayer_id
  @taxpayer_id
end

#unit2Object

The street address line 2 of the primary holder.



44
45
46
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 44

def unit2
  @unit2
end

#us_accredited_categoryObject

The United States accredited investor information.



23
24
25
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 23

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



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 464

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 = DealMakerAPI.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



160
161
162
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 160

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 126

def self.attribute_map
  {
    :'email' => :'email',
    :'us_accredited_category' => :'us_accredited_category',
    :'ca_accredited_investor' => :'ca_accredited_investor',
    :'joint_type' => :'joint_type',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'suffix' => :'suffix',
    :'street_address' => :'street_address',
    :'unit2' => :'unit2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postal_code',
    :'date_of_birth' => :'date_of_birth',
    :'taxpayer_id' => :'taxpayer_id',
    :'phone_number' => :'phone_number',
    :'income' => :'income',
    :'net_worth' => :'net_worth',
    :'reg_cf_prior_offerings_amount' => :'reg_cf_prior_offerings_amount',
    :'joint_holder_first_name' => :'joint_holder_first_name',
    :'joint_holder_last_name' => :'joint_holder_last_name',
    :'joint_holder_suffix' => :'joint_holder_suffix',
    :'joint_holder_street_address' => :'joint_holder_street_address',
    :'joint_holder_unit2' => :'joint_holder_unit2',
    :'joint_holder_city' => :'joint_holder_city',
    :'joint_holder_region' => :'joint_holder_region',
    :'joint_holder_postal_code' => :'joint_holder_postal_code',
    :'joint_holder_date_of_birth' => :'joint_holder_date_of_birth',
    :'joint_holder_taxpayer_id' => :'joint_holder_taxpayer_id'
  }
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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 440

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



199
200
201
202
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 199

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

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 165

def self.openapi_types
  {
    :'email' => :'String',
    :'us_accredited_category' => :'String',
    :'ca_accredited_investor' => :'String',
    :'joint_type' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'suffix' => :'String',
    :'street_address' => :'String',
    :'unit2' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'date_of_birth' => :'String',
    :'taxpayer_id' => :'String',
    :'phone_number' => :'String',
    :'income' => :'Float',
    :'net_worth' => :'Float',
    :'reg_cf_prior_offerings_amount' => :'Float',
    :'joint_holder_first_name' => :'String',
    :'joint_holder_last_name' => :'String',
    :'joint_holder_suffix' => :'String',
    :'joint_holder_street_address' => :'String',
    :'joint_holder_unit2' => :'String',
    :'joint_holder_city' => :'String',
    :'joint_holder_region' => :'String',
    :'joint_holder_postal_code' => :'String',
    :'joint_holder_date_of_birth' => :'String',
    :'joint_holder_taxpayer_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 392

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      us_accredited_category == o.us_accredited_category &&
      ca_accredited_investor == o.ca_accredited_investor &&
      joint_type == o.joint_type &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      suffix == o.suffix &&
      street_address == o.street_address &&
      unit2 == o.unit2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      date_of_birth == o.date_of_birth &&
      taxpayer_id == o.taxpayer_id &&
      phone_number == o.phone_number &&
      income == o.income &&
      net_worth == o.net_worth &&
      reg_cf_prior_offerings_amount == o.reg_cf_prior_offerings_amount &&
      joint_holder_first_name == o.joint_holder_first_name &&
      joint_holder_last_name == o.joint_holder_last_name &&
      joint_holder_suffix == o.joint_holder_suffix &&
      joint_holder_street_address == o.joint_holder_street_address &&
      joint_holder_unit2 == o.joint_holder_unit2 &&
      joint_holder_city == o.joint_holder_city &&
      joint_holder_region == o.joint_holder_region &&
      joint_holder_postal_code == o.joint_holder_postal_code &&
      joint_holder_date_of_birth == o.joint_holder_date_of_birth &&
      joint_holder_taxpayer_id == o.joint_holder_taxpayer_id
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



535
536
537
538
539
540
541
542
543
544
545
546
547
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 535

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


427
428
429
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 427

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



433
434
435
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 433

def hash
  [email, us_accredited_category, ca_accredited_investor, joint_type, first_name, last_name, suffix, street_address, unit2, city, region, postal_code, date_of_birth, taxpayer_id, phone_number, income, net_worth, reg_cf_prior_offerings_amount, joint_holder_first_name, joint_holder_last_name, joint_holder_suffix, joint_holder_street_address, joint_holder_unit2, joint_holder_city, joint_holder_region, joint_holder_postal_code, joint_holder_date_of_birth, joint_holder_taxpayer_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



336
337
338
339
340
341
342
343
344
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 336

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @email.nil?
    invalid_properties.push('invalid value for "email", email 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



511
512
513
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 511

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



517
518
519
520
521
522
523
524
525
526
527
528
529
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 517

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



505
506
507
# File 'lib/DealMakerAPI/models/post_investor_profiles_joints.rb', line 505

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email.nil?
  us_accredited_category_validator = EnumAttributeValidator.new('String', ["income_individual", "assets_individual", "director", "knowledgable_employee", "broker_or_dealer", "investment_advisor_registered", "investment_advisor_relying", "designated_accredited_investor", "not_accredited"])
  return false unless us_accredited_category_validator.valid?(@us_accredited_category)
  ca_accredited_investor_validator = EnumAttributeValidator.new('String', ["d", "e", "e_1", "j", "j_1", "k_alone", "k_spouse", "l", "q", "v", "x"])
  return false unless ca_accredited_investor_validator.valid?(@ca_accredited_investor)
  joint_type_validator = EnumAttributeValidator.new('String', ["joint_tenant", "tenants_in_common", "community_property"])
  return false unless joint_type_validator.valid?(@joint_type)
  true
end