Class: ESIClient::GetCorporationsCorporationIdCustomsOffices200Ok

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/models/get_corporations_corporation_id_customs_offices_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 = {}) ⇒ GetCorporationsCorporationIdCustomsOffices200Ok

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
127
128
129
130
131
132
133
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
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 124

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?(:'office_id')
    self.office_id = attributes[:'office_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alliance_tax_rateObject

Only present if alliance access is allowed



37
38
39
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 37

def alliance_tax_rate
  @alliance_tax_rate
end

#allow_access_with_standingsObject

standing_level and any standing related tax rate only present when this is true



40
41
42
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 40

def allow_access_with_standings
  @allow_access_with_standings
end

#allow_alliance_accessObject

allow_alliance_access boolean



34
35
36
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 34

def allow_alliance_access
  @allow_alliance_access
end

#bad_standing_tax_rateObject

bad_standing_tax_rate number



55
56
57
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 55

def bad_standing_tax_rate
  @bad_standing_tax_rate
end

#corporation_tax_rateObject

corporation_tax_rate number



31
32
33
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 31

def corporation_tax_rate
  @corporation_tax_rate
end

#excellent_standing_tax_rateObject

Tax rate for entities with excellent level of standing, only present if this level is allowed, same for all other standing related tax rates



46
47
48
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 46

def excellent_standing_tax_rate
  @excellent_standing_tax_rate
end

#good_standing_tax_rateObject

good_standing_tax_rate number



49
50
51
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 49

def good_standing_tax_rate
  @good_standing_tax_rate
end

#neutral_standing_tax_rateObject

neutral_standing_tax_rate number



52
53
54
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 52

def neutral_standing_tax_rate
  @neutral_standing_tax_rate
end

#office_idObject

unique ID of this customs office



19
20
21
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 19

def office_id
  @office_id
end

#reinforce_exit_endObject

reinforce_exit_end integer



28
29
30
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 28

def reinforce_exit_end
  @reinforce_exit_end
end

#reinforce_exit_startObject

Together with reinforce_exit_end, marks a 2-hour period where this customs office could exit reinforcement mode during the day after initial attack



25
26
27
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 25

def reinforce_exit_start
  @reinforce_exit_start
end

#standing_levelObject

Access is allowed only for entities with this level of standing or better



43
44
45
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 43

def standing_level
  @standing_level
end

#system_idObject

ID of the solar system this customs office is located in



22
23
24
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 22

def system_id
  @system_id
end

#terrible_standing_tax_rateObject

terrible_standing_tax_rate number



58
59
60
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 58

def terrible_standing_tax_rate
  @terrible_standing_tax_rate
end

Class Method Details

.attribute_mapObject

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 83

def self.attribute_map
  {
    :'office_id' => :'office_id',
    :'system_id' => :'system_id',
    :'reinforce_exit_start' => :'reinforce_exit_start',
    :'reinforce_exit_end' => :'reinforce_exit_end',
    :'corporation_tax_rate' => :'corporation_tax_rate',
    :'allow_alliance_access' => :'allow_alliance_access',
    :'alliance_tax_rate' => :'alliance_tax_rate',
    :'allow_access_with_standings' => :'allow_access_with_standings',
    :'standing_level' => :'standing_level',
    :'excellent_standing_tax_rate' => :'excellent_standing_tax_rate',
    :'good_standing_tax_rate' => :'good_standing_tax_rate',
    :'neutral_standing_tax_rate' => :'neutral_standing_tax_rate',
    :'bad_standing_tax_rate' => :'bad_standing_tax_rate',
    :'terrible_standing_tax_rate' => :'terrible_standing_tax_rate'
  }
end

.swagger_typesObject

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 103

def self.swagger_types
  {
    :'office_id' => :'Integer',
    :'system_id' => :'Integer',
    :'reinforce_exit_start' => :'Integer',
    :'reinforce_exit_end' => :'Integer',
    :'corporation_tax_rate' => :'Float',
    :'allow_alliance_access' => :'BOOLEAN',
    :'alliance_tax_rate' => :'Float',
    :'allow_access_with_standings' => :'BOOLEAN',
    :'standing_level' => :'String',
    :'excellent_standing_tax_rate' => :'Float',
    :'good_standing_tax_rate' => :'Float',
    :'neutral_standing_tax_rate' => :'Float',
    :'bad_standing_tax_rate' => :'Float',
    :'terrible_standing_tax_rate' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      office_id == o.office_id &&
      system_id == o.system_id &&
      reinforce_exit_start == o.reinforce_exit_start &&
      reinforce_exit_end == o.reinforce_exit_end &&
      corporation_tax_rate == o.corporation_tax_rate &&
      allow_alliance_access == o.allow_alliance_access &&
      alliance_tax_rate == o.alliance_tax_rate &&
      allow_access_with_standings == o.allow_access_with_standings &&
      standing_level == o.standing_level &&
      excellent_standing_tax_rate == o.excellent_standing_tax_rate &&
      good_standing_tax_rate == o.good_standing_tax_rate &&
      neutral_standing_tax_rate == o.neutral_standing_tax_rate &&
      bad_standing_tax_rate == o.bad_standing_tax_rate &&
      terrible_standing_tax_rate == o.terrible_standing_tax_rate
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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 355

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

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



421
422
423
424
425
426
427
428
429
430
431
432
433
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 421

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 334

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


321
322
323
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 321

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



327
328
329
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 327

def hash
  [office_id, system_id, reinforce_exit_start, reinforce_exit_end, corporation_tax_rate, allow_alliance_access, alliance_tax_rate, allow_access_with_standings, standing_level, excellent_standing_tax_rate, good_standing_tax_rate, neutral_standing_tax_rate, bad_standing_tax_rate, terrible_standing_tax_rate].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 189

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

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

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

  if @reinforce_exit_start > 23
    invalid_properties.push('invalid value for "reinforce_exit_start", must be smaller than or equal to 23.')
  end

  if @reinforce_exit_start < 0
    invalid_properties.push('invalid value for "reinforce_exit_start", must be greater than or equal to 0.')
  end

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

  if @reinforce_exit_end > 23
    invalid_properties.push('invalid value for "reinforce_exit_end", must be smaller than or equal to 23.')
  end

  if @reinforce_exit_end < 0
    invalid_properties.push('invalid value for "reinforce_exit_end", must be greater than or equal to 0.')
  end

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



401
402
403
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 401

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



407
408
409
410
411
412
413
414
415
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 407

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



395
396
397
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 395

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/esi_client/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 236

def valid?
  return false if @office_id.nil?
  return false if @system_id.nil?
  return false if @reinforce_exit_start.nil?
  return false if @reinforce_exit_start > 23
  return false if @reinforce_exit_start < 0
  return false if @reinforce_exit_end.nil?
  return false if @reinforce_exit_end > 23
  return false if @reinforce_exit_end < 0
  return false if @allow_alliance_access.nil?
  return false if @allow_access_with_standings.nil?
  standing_level_validator = EnumAttributeValidator.new('String', ['bad', 'excellent', 'good', 'neutral', 'terrible'])
  return false unless standing_level_validator.valid?(@standing_level)
  true
end