Class: DealMakerAPI::PatchInvestorProfilesTrusts

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

Overview

Patch trust investor profile

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PatchInvestorProfilesTrusts

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/DealMakerAPI/models/patch_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::PatchInvestorProfilesTrusts` 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::PatchInvestorProfilesTrusts`. 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']
  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?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  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?(:'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/patch_investor_profiles_trusts.rb', line 26

def ca_accredited_investor
  @ca_accredited_investor
end

#city ⇒ Object

Trust city.



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

def city
  @city
end

#date ⇒ Object

The creation date of the trust.



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

def date
  @date
end

#email ⇒ Object

The email associated with the profile to be updated.



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

def email
  @email
end

#income ⇒ Object

The income of the Trust.



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

def income
  @income
end

#name ⇒ Object

The name of the trust.



29
30
31
 
# File 'lib/DealMakerAPI/models/patch_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/patch_investor_profiles_trusts.rb', line 56

def net_worth
  @net_worth
end

#phone_number ⇒ Object

The phone number of the trust.



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Trust postal code or zipcode.



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

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/patch_investor_profiles_trusts.rb', line 59

def reg_cf_prior_offerings_amount
  @reg_cf_prior_offerings_amount
end

#region ⇒ Object

Trust region or state.



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

def region
  @region
end

#street_address ⇒ Object

Trust street address.



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

def street_address
  @street_address
end

#trustees ⇒ Object

Returns the value of attribute trustees.



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

def trustees
  @trustees
end

#unit2 ⇒ Object

Trust street address line 2.



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

def unit2
  @unit2
end

#us_accredited_category ⇒ Object

The United States accredited investor information.



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

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 316

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/patch_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/patch_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',
    :'phone_number' => :'phone_number',
    :'street_address' => :'street_address',
    :'unit2' => :'unit2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postal_code',
    :'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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 292

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/patch_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/patch_investor_profiles_trusts.rb', line 112

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 257

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 &&
      phone_number == o.phone_number &&
      street_address == o.street_address &&
      unit2 == o.unit2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 387

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


279
280
281
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 285

def hash
  [email, us_accredited_category, ca_accredited_investor, name, date, phone_number, street_address, unit2, city, region, postal_code, 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?

Returns:

  • Array for valid properties with the reasons



218
219
220
221
222
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 218

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



363
364
365
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 363

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 369

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



357
358
359
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 357

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



226
227
228
229
230
231
232
233
 
# File 'lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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