Class: ESIClient::GetCharactersCharacterIdOrdersHistory200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_characters_character_id_orders_history_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 = {}) ⇒ GetCharactersCharacterIdOrdersHistory200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
192
193
194
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 129

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  if attributes.has_key?(:'region_id')
    self.region_id = attributes[:'region_id']
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'escrow')
    self.escrow = attributes[:'escrow']
  end

  if attributes.has_key?(:'duration')
    self.duration = attributes[:'duration']
  end

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

  if attributes.has_key?(:'is_corporation')
    self.is_corporation = attributes[:'is_corporation']
  end
end

Instance Attribute Details

#duration ⇒ Object

Number of days the order was valid for (starting from the issued date). An order expires at time issued + duration



55
56
57
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 55

def duration
  @duration
end

#escrow ⇒ Object

For buy orders, the amount of ISK in escrow



52
53
54
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 52

def escrow
  @escrow
end

#is_buy_order ⇒ Object

True if the order is a bid (buy) order



46
47
48
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 46

def is_buy_order
  @is_buy_order
end

#is_corporation ⇒ Object

Signifies whether the buy/sell order was placed on behalf of a corporation.



61
62
63
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 61

def is_corporation
  @is_corporation
end

#issued ⇒ Object

Date and time when this order was issued



43
44
45
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 43

def issued
  @issued
end

#location_id ⇒ Object

ID of the location where order was placed



28
29
30
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 28

def location_id
  @location_id
end

#min_volume ⇒ Object

For buy orders, the minimum quantity that will be accepted in a matching sell order



49
50
51
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 49

def min_volume
  @min_volume
end

#order_id ⇒ Object

Unique order ID



19
20
21
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 19

def order_id
  @order_id
end

#price ⇒ Object

Cost per unit for this order



34
35
36
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 34

def price
  @price
end

#range ⇒ Object

Valid order range, numbers are ranges in jumps



31
32
33
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 31

def range
  @range
end

#region_id ⇒ Object

ID of the region where order was placed



25
26
27
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 25

def region_id
  @region_id
end

#state ⇒ Object

Current order state



58
59
60
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 58

def state
  @state
end

#type_id ⇒ Object

The type ID of the item transacted in this order



22
23
24
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 22

def type_id
  @type_id
end

#volume_remain ⇒ Object

Quantity of items still required or offered



40
41
42
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 40

def volume_remain
  @volume_remain
end

#volume_total ⇒ Object

Quantity of items required or offered at time order was placed



37
38
39
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 37

def volume_total
  @volume_total
end

Class Method Details

.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/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 86

def self.attribute_map
  {
    :'order_id' => :'order_id',
    :'type_id' => :'type_id',
    :'region_id' => :'region_id',
    :'location_id' => :'location_id',
    :'range' => :'range',
    :'price' => :'price',
    :'volume_total' => :'volume_total',
    :'volume_remain' => :'volume_remain',
    :'issued' => :'issued',
    :'is_buy_order' => :'is_buy_order',
    :'min_volume' => :'min_volume',
    :'escrow' => :'escrow',
    :'duration' => :'duration',
    :'state' => :'state',
    :'is_corporation' => :'is_corporation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 107

def self.swagger_types
  {
    :'order_id' => :'Integer',
    :'type_id' => :'Integer',
    :'region_id' => :'Integer',
    :'location_id' => :'Integer',
    :'range' => :'String',
    :'price' => :'Float',
    :'volume_total' => :'Integer',
    :'volume_remain' => :'Integer',
    :'issued' => :'DateTime',
    :'is_buy_order' => :'BOOLEAN',
    :'min_volume' => :'Integer',
    :'escrow' => :'Float',
    :'duration' => :'Integer',
    :'state' => :'String',
    :'is_corporation' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order_id == o.order_id &&
      type_id == o.type_id &&
      region_id == o.region_id &&
      location_id == o.location_id &&
      range == o.range &&
      price == o.price &&
      volume_total == o.volume_total &&
      volume_remain == o.volume_remain &&
      issued == o.issued &&
      is_buy_order == o.is_buy_order &&
      min_volume == o.min_volume &&
      escrow == o.escrow &&
      duration == o.duration &&
      state == o.state &&
      is_corporation == o.is_corporation
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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 351

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
    temp_model = ESIClient.const_get(type).new
    temp_model.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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 417

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 330

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



323
324
325
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 323

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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 198

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

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

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

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

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

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

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

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

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

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

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

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



397
398
399
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 397

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



403
404
405
406
407
408
409
410
411
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 403

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



391
392
393
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 391

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/esi_client/models/get_characters_character_id_orders_history_200_ok.rb', line 253

def valid?
  return false if @order_id.nil?
  return false if @type_id.nil?
  return false if @region_id.nil?
  return false if @location_id.nil?
  return false if @range.nil?
  range_validator = EnumAttributeValidator.new('String', ['1', '10', '2', '20', '3', '30', '4', '40', '5', 'region', 'solarsystem', 'station'])
  return false unless range_validator.valid?(@range)
  return false if @price.nil?
  return false if @volume_total.nil?
  return false if @volume_remain.nil?
  return false if @issued.nil?
  return false if @duration.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ['cancelled', 'expired'])
  return false unless state_validator.valid?(@state)
  return false if @is_corporation.nil?
  true
end