Class: ESI::GetMarketsRegionIdOrders200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb

Overview

200 ok object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetMarketsRegionIdOrders200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
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
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
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#duration ⇒ Object

duration integer



18
19
20
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 18

def duration
  @duration
end

#is_buy_order ⇒ Object

is_buy_order boolean



21
22
23
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 21

def is_buy_order
  @is_buy_order
end

#issued ⇒ Object

issued string



24
25
26
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 24

def issued
  @issued
end

#location_id ⇒ Object

location_id integer



27
28
29
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 27

def location_id
  @location_id
end

#min_volume ⇒ Object

min_volume integer



30
31
32
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 30

def min_volume
  @min_volume
end

#order_id ⇒ Object

order_id integer



33
34
35
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 33

def order_id
  @order_id
end

#price ⇒ Object

price number



36
37
38
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 36

def price
  @price
end

#range ⇒ Object

range string



39
40
41
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 39

def range
  @range
end

#system_id ⇒ Object

The solar system this order was placed



42
43
44
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 42

def system_id
  @system_id
end

#type_id ⇒ Object

type_id integer



45
46
47
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 45

def type_id
  @type_id
end

#volume_remain ⇒ Object

volume_remain integer



48
49
50
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 48

def volume_remain
  @volume_remain
end

#volume_total ⇒ Object

volume_total integer



51
52
53
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 51

def volume_total
  @volume_total
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 76

def self.attribute_map
  {
    :'duration' => :'duration',
    :'is_buy_order' => :'is_buy_order',
    :'issued' => :'issued',
    :'location_id' => :'location_id',
    :'min_volume' => :'min_volume',
    :'order_id' => :'order_id',
    :'price' => :'price',
    :'range' => :'range',
    :'system_id' => :'system_id',
    :'type_id' => :'type_id',
    :'volume_remain' => :'volume_remain',
    :'volume_total' => :'volume_total'
  }
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



300
301
302
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 300

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 94

def self.openapi_types
  {
    :'duration' => :'Object',
    :'is_buy_order' => :'Object',
    :'issued' => :'Object',
    :'location_id' => :'Object',
    :'min_volume' => :'Object',
    :'order_id' => :'Object',
    :'price' => :'Object',
    :'range' => :'Object',
    :'system_id' => :'Object',
    :'type_id' => :'Object',
    :'volume_remain' => :'Object',
    :'volume_total' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 268

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      duration == o.duration &&
      is_buy_order == o.is_buy_order &&
      issued == o.issued &&
      location_id == o.location_id &&
      min_volume == o.min_volume &&
      order_id == o.order_id &&
      price == o.price &&
      range == o.range &&
      system_id == o.system_id &&
      type_id == o.type_id &&
      volume_remain == o.volume_remain &&
      volume_total == o.volume_total
end

#_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



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
361
362
363
364
365
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 330

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    ESI.const_get(type).build_from_hash(value)
  end
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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 399

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

#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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 307

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 293

def hash
  [duration, is_buy_order, issued, location_id, min_volume, order_id, price, range, system_id, type_id, volume_remain, volume_total].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



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 183

def list_invalid_properties
  invalid_properties = Array.new
  if @duration.nil?
    invalid_properties.push('invalid value for "duration", duration cannot be nil.')
  end

  if @is_buy_order.nil?
    invalid_properties.push('invalid value for "is_buy_order", is_buy_order cannot be nil.')
  end

  if @issued.nil?
    invalid_properties.push('invalid value for "issued", issued cannot be nil.')
  end

  if @location_id.nil?
    invalid_properties.push('invalid value for "location_id", location_id cannot be nil.')
  end

  if @min_volume.nil?
    invalid_properties.push('invalid value for "min_volume", min_volume cannot be nil.')
  end

  if @order_id.nil?
    invalid_properties.push('invalid value for "order_id", order_id cannot be nil.')
  end

  if @price.nil?
    invalid_properties.push('invalid value for "price", price cannot be nil.')
  end

  if @range.nil?
    invalid_properties.push('invalid value for "range", range cannot be nil.')
  end

  if @system_id.nil?
    invalid_properties.push('invalid value for "system_id", system_id cannot be nil.')
  end

  if @type_id.nil?
    invalid_properties.push('invalid value for "type_id", type_id cannot be nil.')
  end

  if @volume_remain.nil?
    invalid_properties.push('invalid value for "volume_remain", volume_remain cannot be nil.')
  end

  if @volume_total.nil?
    invalid_properties.push('invalid value for "volume_total", volume_total 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



375
376
377
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 381

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



369
370
371
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 369

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ruby-esi/models/get_markets_region_id_orders_200_ok.rb', line 238

def valid?
  return false if @duration.nil?
  return false if @is_buy_order.nil?
  return false if @issued.nil?
  return false if @location_id.nil?
  return false if @min_volume.nil?
  return false if @order_id.nil?
  return false if @price.nil?
  return false if @range.nil?
  range_validator = EnumAttributeValidator.new('Object', ['station', 'region', 'solarsystem', '1', '2', '3', '4', '5', '10', '20', '30', '40'])
  return false unless range_validator.valid?(@range)
  return false if @system_id.nil?
  return false if @type_id.nil?
  return false if @volume_remain.nil?
  return false if @volume_total.nil?
  true
end