Class: EsiClient::GetCharactersCharacterIdOrders200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-ruby/models/get_characters_character_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 = {}) ⇒ GetCharactersCharacterIdOrders200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
196
197
198
199
200
201
202
203
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#account_id ⇒ Object

Wallet division for the buyer or seller of this order. Always 1000 for characters. Currently 1000 through 1006 for corporations



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

def 
  @account_id
end

#duration ⇒ Object

Numer of days for which order is valid (starting from the issued date). An order expires at time issued + duration



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

def duration
  @duration
end

#escrow ⇒ Object

For buy orders, the amount of ISK in escrow



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

def escrow
  @escrow
end

#is_buy_order ⇒ Object

True for a bid (buy) order. False for an offer (sell) order



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

def is_buy_order
  @is_buy_order
end

#is_corp ⇒ Object

is_corp boolean



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

def is_corp
  @is_corp
end

#issued ⇒ Object

Date and time when this order was issued



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

def issued
  @issued
end

#location_id ⇒ Object

ID of the location where order was placed



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

def location_id
  @location_id
end

#min_volume ⇒ Object

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



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

def min_volume
  @min_volume
end

#order_id ⇒ Object

Unique order ID



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

def order_id
  @order_id
end

#price ⇒ Object

Cost per unit for this order



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

def price
  @price
end

#range ⇒ Object

Valid order range, numbers are ranges in jumps



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

def range
  @range
end

#region_id ⇒ Object

ID of the region where order was placed



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

def region_id
  @region_id
end

#state ⇒ Object

Current order state



54
55
56
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 54

def state
  @state
end

#type_id ⇒ Object

The type ID of the item transacted in this order



57
58
59
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 57

def type_id
  @type_id
end

#volume_remain ⇒ Object

Quantity of items still required or offered



60
61
62
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 60

def volume_remain
  @volume_remain
end

#volume_total ⇒ Object

Quantity of items required or offered at time order was placed



63
64
65
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 63

def volume_total
  @volume_total
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 88

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

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 110

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 324

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 381

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 447

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 360

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


347
348
349
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



353
354
355
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 353

def hash
  [, duration, escrow, is_buy_order, is_corp, issued, location_id, min_volume, order_id, price, range, region_id, state, 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 properies with the reasons



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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 207

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

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

  if @escrow.nil?
    invalid_properties.push("invalid value for 'escrow', escrow 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 @is_corp.nil?
    invalid_properties.push("invalid value for 'is_corp', is_corp 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 @region_id.nil?
    invalid_properties.push("invalid value for 'region_id', region_id cannot be nil.")
  end

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

  return 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



427
428
429
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 427

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



433
434
435
436
437
438
439
440
441
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 433

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



421
422
423
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 421

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/esi-ruby/models/get_characters_character_id_orders_200_ok.rb', line 278

def valid?
  return false if @account_id.nil?
  return false if @duration.nil?
  return false if @escrow.nil?
  return false if @is_buy_order.nil?
  return false if @is_corp.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('String', ["station", "region", "solarsystem", "1", "2", "3", "4", "5", "10", "20", "30", "40"])
  return false unless range_validator.valid?(@range)
  return false if @region_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["open", "closed", "expired", "cancelled", "pending", "character_deleted"])
  return false unless state_validator.valid?(@state)
  return false if @type_id.nil?
  return false if @volume_remain.nil?
  return false if @volume_total.nil?
  return true
end