class ESIClient::GetCharactersCharacterIdOrders200Ok
200 ok object
Attributes
Wallet division for the buyer or seller of this order. Always 1000 for characters. Currently 1000 through 1006 for corporations
Number of days the order is valid for (starting from the issued date). An order expires at time issued + duration
For buy orders, the amount of ISK in escrow
True for a bid (buy) order. False for an offer (sell) order
is_corp
boolean
Date and time when this order was issued
ID of the location where order was placed
For bids (buy orders), the minimum quantity that will be accepted in a matching offer (sell order)
Unique order ID
Cost per unit for this order
Valid order range, numbers are ranges in jumps
ID of the region where order was placed
Current order state
The type ID of the item transacted in this order
Quantity of items still required or offered
Quantity of items required or offered at time order was placed
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 89 def self.attribute_map { :'order_id' => :'order_id', :'type_id' => :'type_id', :'region_id' => :'region_id', :'location_id' => :'location_id', :'range' => :'range', :'is_buy_order' => :'is_buy_order', :'price' => :'price', :'volume_total' => :'volume_total', :'volume_remain' => :'volume_remain', :'issued' => :'issued', :'state' => :'state', :'min_volume' => :'min_volume', :'account_id' => :'account_id', :'duration' => :'duration', :'is_corp' => :'is_corp', :'escrow' => :'escrow' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 134 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?(:'is_buy_order') self.is_buy_order = attributes[:'is_buy_order'] 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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'min_volume') self.min_volume = attributes[:'min_volume'] end if attributes.has_key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.has_key?(:'duration') self.duration = attributes[:'duration'] end if attributes.has_key?(:'is_corp') self.is_corp = attributes[:'is_corp'] end if attributes.has_key?(:'escrow') self.escrow = attributes[:'escrow'] end end
Attribute type mapping.
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 111 def self.swagger_types { :'order_id' => :'Integer', :'type_id' => :'Integer', :'region_id' => :'Integer', :'location_id' => :'Integer', :'range' => :'String', :'is_buy_order' => :'BOOLEAN', :'price' => :'Float', :'volume_total' => :'Integer', :'volume_remain' => :'Integer', :'issued' => :'DateTime', :'state' => :'String', :'min_volume' => :'Integer', :'account_id' => :'Integer', :'duration' => :'Integer', :'is_corp' => :'BOOLEAN', :'escrow' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 324 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 && is_buy_order == o.is_buy_order && price == o.price && volume_total == o.volume_total && volume_remain == o.volume_remain && issued == o.issued && state == o.state && min_volume == o.min_volume && account_id == o.account_id && duration == o.duration && is_corp == o.is_corp && escrow == o.escrow end
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_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
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_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
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_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
@see the `==` method @param [Object] Object to be compared
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 347 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 353 def hash [order_id, type_id, region_id, location_id, range, is_buy_order, price, volume_total, volume_remain, issued, state, min_volume, account_id, duration, is_corp, escrow].hash end
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_characters_character_id_orders_200_ok.rb, line 207 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 @is_buy_order.nil? invalid_properties.push('invalid value for "is_buy_order", is_buy_order 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 @state.nil? invalid_properties.push('invalid value for "state", state cannot be nil.') end if @min_volume.nil? invalid_properties.push('invalid value for "min_volume", min_volume cannot be nil.') end 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 @is_corp.nil? invalid_properties.push('invalid value for "is_corp", is_corp cannot be nil.') end if @escrow.nil? invalid_properties.push('invalid value for "escrow", escrow cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] range Object to be assigned
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 304 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
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 314 def state=(state) validator = EnumAttributeValidator.new('String', ['cancelled', 'character_deleted', 'closed', 'expired', 'open', 'pending']) unless validator.valid?(state) fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.' end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/esi_client/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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/esi_client/models/get_characters_character_id_orders_200_ok.rb, line 421 def to_s to_hash.to_s end
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_characters_character_id_orders_200_ok.rb, line 278 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 @is_buy_order.nil? 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 @state.nil? state_validator = EnumAttributeValidator.new('String', ['cancelled', 'character_deleted', 'closed', 'expired', 'open', 'pending']) return false unless state_validator.valid?(@state) return false if @min_volume.nil? return false if @account_id.nil? return false if @duration.nil? return false if @is_corp.nil? return false if @escrow.nil? true end