Class: DealMakerAPI::PostInvestorProfilesManaged

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

Overview

Create new managed investor profile.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInvestorProfilesManaged

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

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

  if attributes.key?(:'confirmation')
    self.confirmation = attributes[:'confirmation']
  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?(:'beneficiary_account_number')
    self. = attributes[:'beneficiary_account_number']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#beneficiary_account_number ⇒ Object

The account number of the beneficiary (required).



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

def 
  
end

#beneficiary_city ⇒ Object

The city of the beneficiary (required).



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

def beneficiary_city
  @beneficiary_city
end

#beneficiary_date_of_birth ⇒ Object

The date of birth of the beneficiary (required).



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

def beneficiary_date_of_birth
  @beneficiary_date_of_birth
end

#beneficiary_first_name ⇒ Object

The first name of the beneficiary (required).



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

def beneficiary_first_name
  @beneficiary_first_name
end

#beneficiary_last_name ⇒ Object

The last name of the beneficiary (required).



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

def beneficiary_last_name
  @beneficiary_last_name
end

#beneficiary_phone_number ⇒ Object

The phone number of the beneficiary (required).



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

def beneficiary_phone_number
  @beneficiary_phone_number
end

#beneficiary_postal_code ⇒ Object

The postal code or zipcode of the beneficiary (required).



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

def beneficiary_postal_code
  @beneficiary_postal_code
end

#beneficiary_region ⇒ Object

The region or state of the beneficiary (required).



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

def beneficiary_region
  @beneficiary_region
end

#beneficiary_street_address ⇒ Object

The street address of the beneficiary (required).



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

def beneficiary_street_address
  @beneficiary_street_address
end

#beneficiary_suffix ⇒ Object

The suffix of the beneficiary.



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

def beneficiary_suffix
  @beneficiary_suffix
end

#beneficiary_taxpayer_id ⇒ Object

The taxpayer identification number of the beneficiary (required).



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

def beneficiary_taxpayer_id
  @beneficiary_taxpayer_id
end

#beneficiary_unit2 ⇒ Object

The street address line 2 of the beneficiary.



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

def beneficiary_unit2
  @beneficiary_unit2
end

#ca_accredited_investor ⇒ Object

The Canadian accredited investor information.



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

def ca_accredited_investor
  @ca_accredited_investor
end

#city ⇒ Object

The city of the provider (required).



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

def city
  @city
end

#confirmation ⇒ Object

Confirms that the provider is able to custody these securities and release respective funds in order to complete the purchase (required).



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

def confirmation
  @confirmation
end

#email ⇒ Object

User email which is associated with investor profile (required).



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

def email
  @email
end

#income ⇒ Object

The income of the managed investor profile



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

def income
  @income
end

#name ⇒ Object

The name of the provider (required).



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

def name
  @name
end

#net_worth ⇒ Object

The net worth of the managed investor profile



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

def net_worth
  @net_worth
end

#postal_code ⇒ Object

The postal code or zipcode of the provider (required).



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

def postal_code
  @postal_code
end

#reg_cf_prior_offerings_amount ⇒ Object

The prior offering amount of the managed investor profile



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

def reg_cf_prior_offerings_amount
  @reg_cf_prior_offerings_amount
end

#region ⇒ Object

The region or state of the provider (required).



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

def region
  @region
end

#street_address ⇒ Object

The street address of the provider (required).



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

def street_address
  @street_address
end

#taxpayer_id ⇒ Object

The taxpayer identification number of the provider (required).



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

def taxpayer_id
  @taxpayer_id
end

#unit2 ⇒ Object

The street address line 2 of the provider.



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

def unit2
  @unit2
end

#us_accredited_category ⇒ Object

The United States accredited investor information.



23
24
25
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.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



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
462
463
464
465
466
467
468
469
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 432

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



152
153
154
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 152

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'email' => :'email',
    :'us_accredited_category' => :'us_accredited_category',
    :'ca_accredited_investor' => :'ca_accredited_investor',
    :'name' => :'name',
    :'street_address' => :'street_address',
    :'unit2' => :'unit2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postal_code',
    :'taxpayer_id' => :'taxpayer_id',
    :'confirmation' => :'confirmation',
    :'income' => :'income',
    :'net_worth' => :'net_worth',
    :'reg_cf_prior_offerings_amount' => :'reg_cf_prior_offerings_amount',
    :'beneficiary_account_number' => :'beneficiary_account_number',
    :'beneficiary_first_name' => :'beneficiary_first_name',
    :'beneficiary_last_name' => :'beneficiary_last_name',
    :'beneficiary_suffix' => :'beneficiary_suffix',
    :'beneficiary_street_address' => :'beneficiary_street_address',
    :'beneficiary_unit2' => :'beneficiary_unit2',
    :'beneficiary_city' => :'beneficiary_city',
    :'beneficiary_region' => :'beneficiary_region',
    :'beneficiary_postal_code' => :'beneficiary_postal_code',
    :'beneficiary_date_of_birth' => :'beneficiary_date_of_birth',
    :'beneficiary_taxpayer_id' => :'beneficiary_taxpayer_id',
    :'beneficiary_phone_number' => :'beneficiary_phone_number'
  }
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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 408

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



189
190
191
192
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 189

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'email' => :'String',
    :'us_accredited_category' => :'String',
    :'ca_accredited_investor' => :'String',
    :'name' => :'String',
    :'street_address' => :'String',
    :'unit2' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'taxpayer_id' => :'String',
    :'confirmation' => :'Boolean',
    :'income' => :'Float',
    :'net_worth' => :'Float',
    :'reg_cf_prior_offerings_amount' => :'Float',
    :'beneficiary_account_number' => :'String',
    :'beneficiary_first_name' => :'String',
    :'beneficiary_last_name' => :'String',
    :'beneficiary_suffix' => :'String',
    :'beneficiary_street_address' => :'String',
    :'beneficiary_unit2' => :'String',
    :'beneficiary_city' => :'String',
    :'beneficiary_region' => :'String',
    :'beneficiary_postal_code' => :'String',
    :'beneficiary_date_of_birth' => :'String',
    :'beneficiary_taxpayer_id' => :'String',
    :'beneficiary_phone_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      name == o.name &&
      street_address == o.street_address &&
      unit2 == o.unit2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      taxpayer_id == o.taxpayer_id &&
      confirmation == o.confirmation &&
      income == o.income &&
      net_worth == o.net_worth &&
      reg_cf_prior_offerings_amount == o.reg_cf_prior_offerings_amount &&
       == o. &&
      beneficiary_first_name == o.beneficiary_first_name &&
      beneficiary_last_name == o.beneficiary_last_name &&
      beneficiary_suffix == o.beneficiary_suffix &&
      beneficiary_street_address == o.beneficiary_street_address &&
      beneficiary_unit2 == o.beneficiary_unit2 &&
      beneficiary_city == o.beneficiary_city &&
      beneficiary_region == o.beneficiary_region &&
      beneficiary_postal_code == o.beneficiary_postal_code &&
      beneficiary_date_of_birth == o.beneficiary_date_of_birth &&
      beneficiary_taxpayer_id == o.beneficiary_taxpayer_id &&
      beneficiary_phone_number == o.beneficiary_phone_number
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



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 503

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


395
396
397
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 395

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



401
402
403
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 401

def hash
  [email, us_accredited_category, ca_accredited_investor, name, street_address, unit2, city, region, postal_code, taxpayer_id, confirmation, income, net_worth, reg_cf_prior_offerings_amount, , beneficiary_first_name, beneficiary_last_name, beneficiary_suffix, beneficiary_street_address, beneficiary_unit2, beneficiary_city, beneficiary_region, beneficiary_postal_code, beneficiary_date_of_birth, beneficiary_taxpayer_id, beneficiary_phone_number].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



318
319
320
321
322
323
324
325
326
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 318

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



479
480
481
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 479

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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 485

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



473
474
475
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 473

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_managed.rb', line 330

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)
  true
end