Class: DealMakerAPI::PostInvestorProfilesTrusts

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

Overview

Create new trust investor profile.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInvestorProfilesTrusts

Initializes the object



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 140

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

Instance Attribute Details

#ca_accredited_investor ⇒ Object

The Canadian accredited investor information.



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

def ca_accredited_investor
  @ca_accredited_investor
end

#city ⇒ Object

The city of the trust (required).



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

def city
  @city
end

#date ⇒ Object

The creation date of the trust (required).



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

def date
  @date
end

#email ⇒ Object

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



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

def email
  @email
end

#income ⇒ Object

The income of the trust.



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

def income
  @income
end

#name ⇒ Object

The name of the trust (required).



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

def name
  @name
end

#net_worth ⇒ Object

The net worth of the trust.



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

def net_worth
  @net_worth
end

#phone_number ⇒ Object

The phone number of the trust (required).



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

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



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

def postal_code
  @postal_code
end

#reg_cf_prior_offerings_amount ⇒ Object

The prior offering amount of the trust.



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

def reg_cf_prior_offerings_amount
  @reg_cf_prior_offerings_amount
end

#region ⇒ Object

The region or state of the trust (required).



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

def region
  @region
end

#street_address ⇒ Object

Trust street address of the trust (required).



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

def street_address
  @street_address
end

#trustees ⇒ Object

Returns the value of attribute trustees.



61
62
63
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 61

def trustees
  @trustees
end

#unit2 ⇒ Object

The street address line 2 of the trust.



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

def unit2
  @unit2
end

#us_accredited_category ⇒ Object

The United States accredited investor information.



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

def us_accredited_category
  @us_accredited_category
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 323

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



107
108
109
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 86

def self.attribute_map
  {
    :'email' => :'email',
    :'us_accredited_category' => :'us_accredited_category',
    :'ca_accredited_investor' => :'ca_accredited_investor',
    :'name' => :'name',
    :'date' => :'date',
    :'street_address' => :'street_address',
    :'unit2' => :'unit2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postal_code',
    :'phone_number' => :'phone_number',
    :'income' => :'income',
    :'net_worth' => :'net_worth',
    :'reg_cf_prior_offerings_amount' => :'reg_cf_prior_offerings_amount',
    :'trustees' => :'trustees'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 299

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



133
134
135
136
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 112

def self.openapi_types
  {
    :'email' => :'String',
    :'us_accredited_category' => :'String',
    :'ca_accredited_investor' => :'String',
    :'name' => :'String',
    :'date' => :'String',
    :'street_address' => :'String',
    :'unit2' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'income' => :'Float',
    :'net_worth' => :'Float',
    :'reg_cf_prior_offerings_amount' => :'Float',
    :'trustees' => :'Array<PostInvestorProfilesTrustsTrusteesInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 264

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 &&
      date == o.date &&
      street_address == o.street_address &&
      unit2 == o.unit2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      phone_number == o.phone_number &&
      income == o.income &&
      net_worth == o.net_worth &&
      reg_cf_prior_offerings_amount == o.reg_cf_prior_offerings_amount &&
      trustees == o.trustees
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 394

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

See Also:

  • `==` method


286
287
288
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



292
293
294
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 292

def hash
  [email, us_accredited_category, ca_accredited_investor, name, date, street_address, unit2, city, region, postal_code, phone_number, income, net_worth, reg_cf_prior_offerings_amount, trustees].hash
end

#list_invalid_properties ⇒ Object

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



220
221
222
223
224
225
226
227
228
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 220

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)



370
371
372
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 370

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 376

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



364
365
366
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 364

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



232
233
234
235
236
237
238
239
240
 
# File 'lib/DealMakerAPI/models/post_investor_profiles_trusts.rb', line 232

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @email.nil?
  us_accredited_category_validator = EnumAttributeValidator.new('String', ["entity_owned_by_accredited_investors", "broker_or_dealer", "assets_trust", "not_accredited"])
  return false unless us_accredited_category_validator.valid?(@us_accredited_category)
  ca_accredited_investor_validator = EnumAttributeValidator.new('String', ["p", "w"])
  return false unless ca_accredited_investor_validator.valid?(@ca_accredited_investor)
  true
end