Class: ESI::GetCharactersCharacterIdContracts200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/models/get_characters_character_id_contracts_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 = {}) ⇒ GetCharactersCharacterIdContracts200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
216
217
218
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 169

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ESI::GetCharactersCharacterIdContracts200Ok` 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::GetCharactersCharacterIdContracts200Ok`. 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?(:'acceptor_id')
    self.acceptor_id = attributes[:'acceptor_id']
  end

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

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

  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_accepted')
    self.date_accepted = attributes[:'date_accepted']
  end

  if attributes.key?(:'date_completed')
    self.date_completed = attributes[:'date_completed']
  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?(:'status')
    self.status = attributes[:'status']
  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

#acceptor_id ⇒ Object

Who will accept the contract



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

def acceptor_id
  @acceptor_id
end

#assignee_id ⇒ Object

ID to whom the contract is assigned, can be alliance, corporation or character ID



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

def assignee_id
  @assignee_id
end

#availability ⇒ Object

To whom the contract is available



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

def availability
  @availability
end

#buyout ⇒ Object

Buyout price (for Auctions only)



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

def buyout
  @buyout
end

#collateral ⇒ Object

Collateral price (for Couriers only)



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

def collateral
  @collateral
end

#contract_id ⇒ Object

contract_id integer



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

def contract_id
  @contract_id
end

#date_accepted ⇒ Object

Date of confirmation of contract



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

def date_accepted
  @date_accepted
end

#date_completed ⇒ Object

Date of completed of contract



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

def date_completed
  @date_completed
end

#date_expired ⇒ Object

Expiration date of the contract



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

def date_expired
  @date_expired
end

#date_issued ⇒ Object

Сreation date of the contract



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

def date_issued
  @date_issued
end

#days_to_complete ⇒ Object

Number of days to perform the contract



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

def days_to_complete
  @days_to_complete
end

#end_location_id ⇒ Object

End location ID (for Couriers contract)



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

def end_location_id
  @end_location_id
end

#for_corporation ⇒ Object

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



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

def for_corporation
  @for_corporation
end

#issuer_corporation_id ⇒ Object

Character’s corporation ID for the issuer



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

def issuer_corporation_id
  @issuer_corporation_id
end

#issuer_id ⇒ Object

Character ID for the issuer



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

def issuer_id
  @issuer_id
end

#price ⇒ Object

Price of contract (for ItemsExchange and Auctions)



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

def price
  @price
end

#reward ⇒ Object

Remuneration for contract (for Couriers only)



66
67
68
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 66

def reward
  @reward
end

#start_location_id ⇒ Object

Start location ID (for Couriers contract)



69
70
71
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 69

def start_location_id
  @start_location_id
end

#status ⇒ Object

Status of the the contract



72
73
74
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 72

def status
  @status
end

#title ⇒ Object

Title of the contract



75
76
77
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 75

def title
  @title
end

#type ⇒ Object

Type of the contract



78
79
80
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 78

def type
  @type
end

#volume ⇒ Object

Volume of items in the contract



81
82
83
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 81

def volume
  @volume
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 106

def self.attribute_map
  {
    :'acceptor_id' => :'acceptor_id',
    :'assignee_id' => :'assignee_id',
    :'availability' => :'availability',
    :'buyout' => :'buyout',
    :'collateral' => :'collateral',
    :'contract_id' => :'contract_id',
    :'date_accepted' => :'date_accepted',
    :'date_completed' => :'date_completed',
    :'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',
    :'status' => :'status',
    :'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



419
420
421
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 419

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 162

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'acceptor_id' => :'Object',
    :'assignee_id' => :'Object',
    :'availability' => :'Object',
    :'buyout' => :'Object',
    :'collateral' => :'Object',
    :'contract_id' => :'Object',
    :'date_accepted' => :'Object',
    :'date_completed' => :'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',
    :'status' => :'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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 377

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acceptor_id == o.acceptor_id &&
      assignee_id == o.assignee_id &&
      availability == o.availability &&
      buyout == o.buyout &&
      collateral == o.collateral &&
      contract_id == o.contract_id &&
      date_accepted == o.date_accepted &&
      date_completed == o.date_completed &&
      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 &&
      status == o.status &&
      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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 449

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



518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 518

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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 426

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


406
407
408
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 406

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



412
413
414
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 412

def hash
  [acceptor_id, assignee_id, availability, buyout, collateral, contract_id, date_accepted, date_completed, date_expired, date_issued, days_to_complete, end_location_id, for_corporation, issuer_corporation_id, issuer_id, price, reward, start_location_id, status, 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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 273

def list_invalid_properties
  invalid_properties = Array.new
  if @acceptor_id.nil?
    invalid_properties.push('invalid value for "acceptor_id", acceptor_id cannot be nil.')
  end

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

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

  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 @for_corporation.nil?
    invalid_properties.push('invalid value for "for_corporation", for_corporation 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 @status.nil?
    invalid_properties.push('invalid value for "status", status 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



494
495
496
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 494

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 500

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



488
489
490
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 488

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ruby-esi/models/get_characters_character_id_contracts_200_ok.rb', line 324

def valid?
  return false if @acceptor_id.nil?
  return false if @assignee_id.nil?
  return false if @availability.nil?
  availability_validator = EnumAttributeValidator.new('Object', ['public', 'personal', 'corporation', 'alliance'])
  return false unless availability_validator.valid?(@availability)
  return false if @contract_id.nil?
  return false if @date_expired.nil?
  return false if @date_issued.nil?
  return false if @for_corporation.nil?
  return false if @issuer_corporation_id.nil?
  return false if @issuer_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('Object', ['outstanding', 'in_progress', 'finished_issuer', 'finished_contractor', 'finished', 'cancelled', 'rejected', 'failed', 'deleted', 'reversed'])
  return false unless status_validator.valid?(@status)
  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