Class: DealMakerAPI::V1EntitiesDeal

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

Overview

V1_Entities_Deal model

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1EntitiesDeal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
187
188
189
190
191
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#currency ⇒ Object

The primary currency associated with the deal.



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

def currency
  @currency
end

#deal_type ⇒ Object

The deal type.



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

def deal_type
  @deal_type
end

#enterprise ⇒ Object

Returns the value of attribute enterprise.



45
46
47
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 45

def enterprise
  @enterprise
end

#funding ⇒ Object

Returns the value of attribute funding.



52
53
54
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 52

def funding
  @funding
end

#id ⇒ Object

The deal’s unique id.



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

def id
  @id
end

#investors ⇒ Object

Returns the value of attribute investors.



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

def investors
  @investors
end

#issuer ⇒ Object

Returns the value of attribute issuer.



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

def issuer
  @issuer
end

#maximum_investment ⇒ Object

The maximum investment amount, in cents.



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

def maximum_investment
  @maximum_investment
end

#minimum_investment ⇒ Object

The minimum investment amount, in cents.



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

def minimum_investment
  @minimum_investment
end

#price_per_security ⇒ Object

The deal price per security.



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

def price_per_security
  @price_per_security
end

#security_type ⇒ Object

The deal security type.



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

def security_type
  @security_type
end

#state ⇒ Object

The deal state.



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

def state
  @state
end

#title ⇒ Object

The deal title.



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

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



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

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



96
97
98
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 77

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'state' => :'state',
    :'currency' => :'currency',
    :'security_type' => :'security_type',
    :'price_per_security' => :'price_per_security',
    :'minimum_investment' => :'minimum_investment',
    :'maximum_investment' => :'maximum_investment',
    :'issuer' => :'issuer',
    :'enterprise' => :'enterprise',
    :'deal_type' => :'deal_type',
    :'investors' => :'investors',
    :'funding' => :'funding'
  }
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 267

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



120
121
122
123
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 120

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 101

def self.openapi_types
  {
    :'id' => :'Integer',
    :'title' => :'String',
    :'state' => :'String',
    :'currency' => :'String',
    :'security_type' => :'String',
    :'price_per_security' => :'Float',
    :'minimum_investment' => :'Integer',
    :'maximum_investment' => :'Integer',
    :'issuer' => :'V1EntitiesDealIssuer',
    :'enterprise' => :'V1EntitiesDealEnterprise',
    :'deal_type' => :'String',
    :'investors' => :'V1EntitiesDealInvestorMetrics',
    :'funding' => :'V1EntitiesDealFundingMetrics'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      state == o.state &&
      currency == o.currency &&
      security_type == o.security_type &&
      price_per_security == o.price_per_security &&
      minimum_investment == o.minimum_investment &&
      maximum_investment == o.maximum_investment &&
      issuer == o.issuer &&
      enterprise == o.enterprise &&
      deal_type == o.deal_type &&
      investors == o.investors &&
      funding == o.funding
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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 362

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


254
255
256
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 260

def hash
  [id, title, state, currency, security_type, price_per_security, minimum_investment, maximum_investment, issuer, enterprise, deal_type, investors, funding].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



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

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



338
339
340
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 344

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



332
333
334
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 332

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



203
204
205
206
207
208
209
210
 
# File 'lib/DealMakerAPI/models/v1_entities_deal.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  state_validator = EnumAttributeValidator.new('String', ["draft", "close", "active", "amending", "ending"])
  return false unless state_validator.valid?(@state)
  deal_type_validator = EnumAttributeValidator.new('String', ["other_or_unknown", "dm_plus", "dm_basic", "mini_deal", "reg_cf", "reg_a", "warrants", "offering_memorandum", "reg_d_506_c", "reg_d_506_b", "reg_s"])
  return false unless deal_type_validator.valid?(@deal_type)
  true
end