Class: DealMakerAPI::V1EntitiesInvestorProfileJoint

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

Overview

V1_Entities_InvestorProfile_Joint model

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1EntitiesInvestorProfileJoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ca_accredited_investor ⇒ Object

The Canadian accredited investor information



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

def ca_accredited_investor
  @ca_accredited_investor
end

#complete ⇒ Object

To check if the profile is complete or not



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

def complete
  @complete
end

#email ⇒ Object

User email



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

def email
  @email
end

#id ⇒ Object

Investor Profile id



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

def id
  @id
end

#joint_holder ⇒ Object

Returns the value of attribute joint_holder.



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

def joint_holder
  @joint_holder
end

#joint_type ⇒ Object

The kind of joint investor



46
47
48
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 46

def joint_type
  @joint_type
end

#owner ⇒ Object

Returns the value of attribute owner.



43
44
45
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 43

def owner
  @owner
end

#owner_type ⇒ Object

Type of the investor profile owner



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

def owner_type
  @owner_type
end

#primary_holder ⇒ Object

Returns the value of attribute primary_holder.



48
49
50
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 48

def primary_holder
  @primary_holder
end

#type ⇒ Object

Investor Profile type



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

def type
  @type
end

#us_accredited_category ⇒ Object

The United States accredited investor information



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

def us_accredited_category
  @us_accredited_category
end

#user_id ⇒ Object

User id



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

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



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

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



93
94
95
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 75

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'user_id',
    :'email' => :'email',
    :'type' => :'type',
    :'us_accredited_category' => :'us_accredited_category',
    :'ca_accredited_investor' => :'ca_accredited_investor',
    :'complete' => :'complete',
    :'owner_type' => :'owner_type',
    :'owner' => :'owner',
    :'joint_type' => :'joint_type',
    :'primary_holder' => :'primary_holder',
    :'joint_holder' => :'joint_holder'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 246

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



116
117
118
119
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 98

def self.openapi_types
  {
    :'id' => :'Integer',
    :'user_id' => :'Integer',
    :'email' => :'String',
    :'type' => :'String',
    :'us_accredited_category' => :'String',
    :'ca_accredited_investor' => :'String',
    :'complete' => :'Boolean',
    :'owner_type' => :'String',
    :'owner' => :'V1EntitiesInvestorProfileOwner',
    :'joint_type' => :'String',
    :'primary_holder' => :'V1EntitiesInvestorProfileFieldsPrimaryHolder',
    :'joint_holder' => :'V1EntitiesInvestorProfileFieldsAccountHolder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      email == o.email &&
      type == o.type &&
      us_accredited_category == o.us_accredited_category &&
      ca_accredited_investor == o.ca_accredited_investor &&
      complete == o.complete &&
      owner_type == o.owner_type &&
      owner == o.owner &&
      joint_type == o.joint_type &&
      primary_holder == o.primary_holder &&
      joint_holder == o.joint_holder
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 341

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


233
234
235
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 239

def hash
  [id, user_id, email, type, us_accredited_category, ca_accredited_investor, complete, owner_type, owner, joint_type, primary_holder, joint_holder].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



187
188
189
190
191
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 187

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



317
318
319
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 323

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



311
312
313
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 311

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



195
196
197
198
199
200
 
# File 'lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb', line 195

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["individual", "joint", "corporation", "trust"])
  return false unless type_validator.valid?(@type)
  true
end