class ESIClient::GetCorporationsCorporationIdOrdersHistory200Ok

200 ok object

Attributes

duration[RW]

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

escrow[RW]

For buy orders, the amount of ISK in escrow

is_buy_order[RW]

True if the order is a bid (buy) order

issued[RW]

Date and time when this order was issued

location_id[RW]

ID of the location where order was placed

min_volume[RW]

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

order_id[RW]

Unique order ID

price[RW]

Cost per unit for this order

range[RW]

Valid order range, numbers are ranges in jumps

region_id[RW]

ID of the region where order was placed

state[RW]

Current order state

type_id[RW]

The type ID of the item transacted in this order

volume_remain[RW]

Quantity of items still required or offered

volume_total[RW]

Quantity of items required or offered at time order was placed

wallet_division[RW]

The corporation wallet division used for this order.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/esi_client/models/get_corporations_corporation_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',
    :'wallet_division' => :'wallet_division'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/esi_client/models/get_corporations_corporation_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?(:'wallet_division')
    self.wallet_division = attributes[:'wallet_division']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/esi_client/models/get_corporations_corporation_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',
    :'wallet_division' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 323
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 &&
      wallet_division == o.wallet_division
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 379
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 445
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 358
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 345
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 351
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, wallet_division].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/esi_client/models/get_corporations_corporation_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 @wallet_division.nil?
    invalid_properties.push('invalid value for "wallet_division", wallet_division cannot be nil.')
  end

  if @wallet_division > 7
    invalid_properties.push('invalid value for "wallet_division", must be smaller than or equal to 7.')
  end

  if @wallet_division < 1
    invalid_properties.push('invalid value for "wallet_division", must be greater than or equal to 1.')
  end

  invalid_properties
end
range=(range) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] range Object to be assigned

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 285
def range=(range)
  validator = EnumAttributeValidator.new('String', ['1', '10', '2', '20', '3', '30', '4', '40', '5', 'region', 'solarsystem', 'station'])
  unless validator.valid?(range)
    fail ArgumentError, 'invalid value for "range", must be one of #{validator.allowable_values}.'
  end
  @range = range
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 295
def state=(state)
  validator = EnumAttributeValidator.new('String', ['cancelled', 'expired'])
  unless validator.valid?(state)
    fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 425
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 431
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 419
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 261
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 @wallet_division.nil?
  return false if @wallet_division > 7
  return false if @wallet_division < 1
  true
end
wallet_division=(wallet_division) click to toggle source

Custom attribute writer method with validation @param [Object] wallet_division Value to be assigned

# File lib/esi_client/models/get_corporations_corporation_id_orders_history_200_ok.rb, line 305
def wallet_division=(wallet_division)
  if wallet_division.nil?
    fail ArgumentError, 'wallet_division cannot be nil'
  end

  if wallet_division > 7
    fail ArgumentError, 'invalid value for "wallet_division", must be smaller than or equal to 7.'
  end

  if wallet_division < 1
    fail ArgumentError, 'invalid value for "wallet_division", must be greater than or equal to 1.'
  end

  @wallet_division = wallet_division
end