class ESI::GetContractsPublicRegionId200Ok

200 ok object

Attributes

buyout[RW]

Buyout price (for Auctions only)

collateral[RW]

Collateral price (for Couriers only)

contract_id[RW]

contract_id integer

date_expired[RW]

Expiration date of the contract

date_issued[RW]

Сreation date of the contract

days_to_complete[RW]

Number of days to perform the contract

end_location_id[RW]

End location ID (for Couriers contract)

for_corporation[RW]

true if the contract was issued on behalf of the issuer's corporation

issuer_corporation_id[RW]

Character's corporation ID for the issuer

issuer_id[RW]

Character ID for the issuer

price[RW]

Price of contract (for ItemsExchange and Auctions)

reward[RW]

Remuneration for contract (for Couriers only)

start_location_id[RW]

Start location ID (for Couriers contract)

title[RW]

Title of the contract

type[RW]

Type of the contract

volume[RW]

Volume of items in the contract

Public Class Methods

attribute_map() click to toggle source

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

# File lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb, line 89
def self.attribute_map
  {
    :'buyout' => :'buyout',
    :'collateral' => :'collateral',
    :'contract_id' => :'contract_id',
    :'date_expired' => :'date_expired',
    :'date_issued' => :'date_issued',
    :'days_to_complete' => :'days_to_complete',
    :'end_location_id' => :'end_location_id',
    :'for_corporation' => :'for_corporation',
    :'issuer_corporation_id' => :'issuer_corporation_id',
    :'issuer_id' => :'issuer_id',
    :'price' => :'price',
    :'reward' => :'reward',
    :'start_location_id' => :'start_location_id',
    :'title' => :'title',
    :'type' => :'type',
    :'volume' => :'volume'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/esi-client-bvv/models/get_contracts_public_region_id_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?(:'buyout')
    self.buyout = attributes[:'buyout']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb, line 111
def self.swagger_types
  {
    :'buyout' => :'Float',
    :'collateral' => :'Float',
    :'contract_id' => :'Integer',
    :'date_expired' => :'DateTime',
    :'date_issued' => :'DateTime',
    :'days_to_complete' => :'Integer',
    :'end_location_id' => :'Integer',
    :'for_corporation' => :'BOOLEAN',
    :'issuer_corporation_id' => :'Integer',
    :'issuer_id' => :'Integer',
    :'price' => :'Float',
    :'reward' => :'Float',
    :'start_location_id' => :'Integer',
    :'title' => :'String',
    :'type' => :'String',
    :'volume' => :'Float'
  }
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 263
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      buyout == o.buyout &&
      collateral == o.collateral &&
      contract_id == o.contract_id &&
      date_expired == o.date_expired &&
      date_issued == o.date_issued &&
      days_to_complete == o.days_to_complete &&
      end_location_id == o.end_location_id &&
      for_corporation == o.for_corporation &&
      issuer_corporation_id == o.issuer_corporation_id &&
      issuer_id == o.issuer_id &&
      price == o.price &&
      reward == o.reward &&
      start_location_id == o.start_location_id &&
      title == o.title &&
      type == o.type &&
      volume == o.volume
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 320
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 = ESI.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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 386
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 299
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 286
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 292
def hash
  [buyout, collateral, contract_id, date_expired, date_issued, days_to_complete, end_location_id, for_corporation, issuer_corporation_id, issuer_id, price, reward, start_location_id, title, type, volume].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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 208
def list_invalid_properties
  invalid_properties = Array.new
  if @contract_id.nil?
    invalid_properties.push("invalid value for 'contract_id', contract_id cannot be nil.")
  end

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

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

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

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

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

  return invalid_properties
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 366
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 372
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 360
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb, line 253
def type=(type)
  validator = EnumAttributeValidator.new('String', ["unknown", "item_exchange", "auction", "courier", "loan"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
  end
  @type = type
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-bvv/models/get_contracts_public_region_id_200_ok.rb, line 239
def valid?
  return false if @contract_id.nil?
  return false if @date_expired.nil?
  return false if @date_issued.nil?
  return false if @issuer_corporation_id.nil?
  return false if @issuer_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["unknown", "item_exchange", "auction", "courier", "loan"])
  return false unless type_validator.valid?(@type)
  return true
end