Class: ESI::GetCorporationsCorporationIdCustomsOffices200Ok

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



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
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#alliance_tax_rate ⇒ Object

Only present if alliance access is allowed



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

def alliance_tax_rate
  @alliance_tax_rate
end

#allow_access_with_standings ⇒ Object

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



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

def allow_access_with_standings
  @allow_access_with_standings
end

#allow_alliance_access ⇒ Object

allow_alliance_access boolean



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

def allow_alliance_access
  @allow_alliance_access
end

#bad_standing_tax_rate ⇒ Object

bad_standing_tax_rate number



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

def bad_standing_tax_rate
  @bad_standing_tax_rate
end

#corporation_tax_rate ⇒ Object

corporation_tax_rate number



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

def corporation_tax_rate
  @corporation_tax_rate
end

#excellent_standing_tax_rate ⇒ Object

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



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

def excellent_standing_tax_rate
  @excellent_standing_tax_rate
end

#good_standing_tax_rate ⇒ Object

good_standing_tax_rate number



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

def good_standing_tax_rate
  @good_standing_tax_rate
end

#neutral_standing_tax_rate ⇒ Object

neutral_standing_tax_rate number



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

def neutral_standing_tax_rate
  @neutral_standing_tax_rate
end

#office_id ⇒ Object

unique ID of this customs office



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

def office_id
  @office_id
end

#reinforce_exit_end ⇒ Object

reinforce_exit_end integer



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

def reinforce_exit_end
  @reinforce_exit_end
end

#reinforce_exit_start ⇒ Object

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



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

def reinforce_exit_start
  @reinforce_exit_start
end

#standing_level ⇒ Object

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



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

def standing_level
  @standing_level
end

#system_id ⇒ Object

ID of the solar system this customs office is located in



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

def system_id
  @system_id
end

#terrible_standing_tax_rate ⇒ Object

terrible_standing_tax_rate number



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

def terrible_standing_tax_rate
  @terrible_standing_tax_rate
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'alliance_tax_rate' => :'alliance_tax_rate',
    :'allow_access_with_standings' => :'allow_access_with_standings',
    :'allow_alliance_access' => :'allow_alliance_access',
    :'bad_standing_tax_rate' => :'bad_standing_tax_rate',
    :'corporation_tax_rate' => :'corporation_tax_rate',
    :'excellent_standing_tax_rate' => :'excellent_standing_tax_rate',
    :'good_standing_tax_rate' => :'good_standing_tax_rate',
    :'neutral_standing_tax_rate' => :'neutral_standing_tax_rate',
    :'office_id' => :'office_id',
    :'reinforce_exit_end' => :'reinforce_exit_end',
    :'reinforce_exit_start' => :'reinforce_exit_start',
    :'standing_level' => :'standing_level',
    :'system_id' => :'system_id',
    :'terrible_standing_tax_rate' => :'terrible_standing_tax_rate'
  }
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



290
291
292
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 290

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 256

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



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
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_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
    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



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 297

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


277
278
279
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 283

def hash
  [alliance_tax_rate, allow_access_with_standings, allow_alliance_access, bad_standing_tax_rate, corporation_tax_rate, excellent_standing_tax_rate, good_standing_tax_rate, neutral_standing_tax_rate, office_id, reinforce_exit_end, reinforce_exit_start, standing_level, system_id, terrible_standing_tax_rate].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



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

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

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

  if @office_id.nil?
    invalid_properties.push('invalid value for "office_id", office_id cannot be nil.')
  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_start.nil?
    invalid_properties.push('invalid value for "reinforce_exit_start", reinforce_exit_start cannot be nil.')
  end

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



365
366
367
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 365

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 371

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



359
360
361
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 359

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



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ruby-esi/models/get_corporations_corporation_id_customs_offices_200_ok.rb', line 232

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