Class: ESI::GetContractsPublicRegionId200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/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



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
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 139

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetContractsPublicRegionId200Ok` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ESI::GetContractsPublicRegionId200Ok`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'buyout')
    self.buyout = attributes[:'buyout']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#buyout ⇒ Object

Buyout price (for Auctions only)



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

def buyout
  @buyout
end

#collateral ⇒ Object

Collateral price (for Couriers only)



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

def collateral
  @collateral
end

#contract_id ⇒ Object

contract_id integer



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

def contract_id
  @contract_id
end

#date_expired ⇒ Object

Expiration date of the contract



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

def date_expired
  @date_expired
end

#date_issued ⇒ Object

Сreation date of the contract



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

def date_issued
  @date_issued
end

#days_to_complete ⇒ Object

Number of days to perform the contract



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

def days_to_complete
  @days_to_complete
end

#end_location_id ⇒ Object

End location ID (for Couriers contract)



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

def end_location_id
  @end_location_id
end

#for_corporation ⇒ Object

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



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

def for_corporation
  @for_corporation
end

#issuer_corporation_id ⇒ Object

Character’s corporation ID for the issuer



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

def issuer_corporation_id
  @issuer_corporation_id
end

#issuer_id ⇒ Object

Character ID for the issuer



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

def issuer_id
  @issuer_id
end

#price ⇒ Object

Price of contract (for ItemsExchange and Auctions)



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

def price
  @price
end

#reward ⇒ Object

Remuneration for contract (for Couriers only)



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

def reward
  @reward
end

#start_location_id ⇒ Object

Start location ID (for Couriers contract)



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

def start_location_id
  @start_location_id
end

#title ⇒ Object

Title of the contract



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

def title
  @title
end

#type ⇒ Object

Type of the contract



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

def type
  @type
end

#volume ⇒ Object

Volume of items in the contract



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

def volume
  @volume
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/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 88

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

.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



310
311
312
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 310

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 132

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_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/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 110

def self.openapi_types
  {
    :'buyout' => :'Object',
    :'collateral' => :'Object',
    :'contract_id' => :'Object',
    :'date_expired' => :'Object',
    :'date_issued' => :'Object',
    :'days_to_complete' => :'Object',
    :'end_location_id' => :'Object',
    :'for_corporation' => :'Object',
    :'issuer_corporation_id' => :'Object',
    :'issuer_id' => :'Object',
    :'price' => :'Object',
    :'reward' => :'Object',
    :'start_location_id' => :'Object',
    :'title' => :'Object',
    :'type' => :'Object',
    :'volume' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 274

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 340

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
    ESI.const_get(type).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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 409

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 317

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 303

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



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
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 219

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

  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



385
386
387
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 385

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 391

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



379
380
381
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 379

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



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ruby-esi/models/get_contracts_public_region_id_200_ok.rb', line 250

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('Object', ['unknown', 'item_exchange', 'auction', 'courier', 'loan'])
  return false unless type_validator.valid?(@type)
  true
end