Class: ESI::GetContractsPublicRegionId200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-client-bvv/models/get_contracts_public_region_id_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 = {}) ⇒ GetContractsPublicRegionId200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
204
 
# 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

Instance Attribute Details

#buyout ⇒ Object

Buyout price (for Auctions only)



19
20
21
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 19

def buyout
  @buyout
end

#collateral ⇒ Object

Collateral price (for Couriers only)



22
23
24
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 22

def collateral
  @collateral
end

#contract_id ⇒ Object

contract_id integer



25
26
27
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 25

def contract_id
  @contract_id
end

#date_expired ⇒ Object

Expiration date of the contract



28
29
30
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 28

def date_expired
  @date_expired
end

#date_issued ⇒ Object

Сreation date of the contract



31
32
33
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 31

def date_issued
  @date_issued
end

#days_to_complete ⇒ Object

Number of days to perform the contract



34
35
36
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 34

def days_to_complete
  @days_to_complete
end

#end_location_id ⇒ Object

End location ID (for Couriers contract)



37
38
39
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 37

def end_location_id
  @end_location_id
end

#for_corporation ⇒ Object

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



40
41
42
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 40

def for_corporation
  @for_corporation
end

#issuer_corporation_id ⇒ Object

Character’s corporation ID for the issuer



43
44
45
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 43

def issuer_corporation_id
  @issuer_corporation_id
end

#issuer_id ⇒ Object

Character ID for the issuer



46
47
48
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 46

def issuer_id
  @issuer_id
end

#price ⇒ Object

Price of contract (for ItemsExchange and Auctions)



49
50
51
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 49

def price
  @price
end

#reward ⇒ Object

Remuneration for contract (for Couriers only)



52
53
54
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 52

def reward
  @reward
end

#start_location_id ⇒ Object

Start location ID (for Couriers contract)



55
56
57
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 55

def start_location_id
  @start_location_id
end

#title ⇒ Object

Title of the contract



58
59
60
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 58

def title
  @title
end

#type ⇒ Object

Type of the contract



61
62
63
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 61

def type
  @type
end

#volume ⇒ Object

Volume of items in the contract



64
65
66
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 64

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# 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) ⇒ 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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 366

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



372
373
374
375
376
377
378
379
380
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



360
361
362
 
# File 'lib/esi-client-bvv/models/get_contracts_public_region_id_200_ok.rb', line 360

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



239
240
241
242
243
244
245
246
247
248
249
 
# 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