Class: EsiClient::GetCharactersCharacterIdWalletJournal200Ok

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
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
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 117

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amountObject

Transaction amount. Positive when value transferred to the first party. Negative otherwise



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

def amount
  @amount
end

#balanceObject

Wallet balance after transaction occurred



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

def balance
  @balance
end

#dateObject

Date and time of transaction



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

def date
  @date
end

#extra_infoObject

Returns the value of attribute extra_info.



26
27
28
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 26

def extra_info
  @extra_info
end

#first_party_idObject

first_party_id integer



29
30
31
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 29

def first_party_id
  @first_party_id
end

#first_party_typeObject

first_party_type string



32
33
34
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 32

def first_party_type
  @first_party_type
end

#reasonObject

reason string



35
36
37
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 35

def reason
  @reason
end

#ref_idObject

Unique journal reference ID



38
39
40
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 38

def ref_id
  @ref_id
end

#ref_typeObject

Transaction type, different type of transaction will populate different fields in ‘extra_info`



41
42
43
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 41

def ref_type
  @ref_type
end

#second_party_idObject

second_party_id integer



44
45
46
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 44

def second_party_id
  @second_party_id
end

#second_party_typeObject

second_party_type string



47
48
49
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 47

def second_party_type
  @second_party_type
end

#taxObject

Tax amount received for tax related transactions



50
51
52
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 50

def tax
  @tax
end

#tax_reciever_idObject

the corporation ID receiving any tax paid



53
54
55
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 53

def tax_reciever_id
  @tax_reciever_id
end

Class Method Details

.attribute_mapObject

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 78

def self.attribute_map
  {
    :'amount' => :'amount',
    :'balance' => :'balance',
    :'date' => :'date',
    :'extra_info' => :'extra_info',
    :'first_party_id' => :'first_party_id',
    :'first_party_type' => :'first_party_type',
    :'reason' => :'reason',
    :'ref_id' => :'ref_id',
    :'ref_type' => :'ref_type',
    :'second_party_id' => :'second_party_id',
    :'second_party_type' => :'second_party_type',
    :'tax' => :'tax',
    :'tax_reciever_id' => :'tax_reciever_id'
  }
end

.swagger_typesObject

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 97

def self.swagger_types
  {
    :'amount' => :'Float',
    :'balance' => :'Float',
    :'date' => :'DateTime',
    :'extra_info' => :'GetCharactersCharacterIdWalletJournalExtraInfo',
    :'first_party_id' => :'Integer',
    :'first_party_type' => :'String',
    :'reason' => :'String',
    :'ref_id' => :'Integer',
    :'ref_type' => :'String',
    :'second_party_id' => :'Integer',
    :'second_party_type' => :'String',
    :'tax' => :'Float',
    :'tax_reciever_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      balance == o.balance &&
      date == o.date &&
      extra_info == o.extra_info &&
      first_party_id == o.first_party_id &&
      first_party_type == o.first_party_type &&
      reason == o.reason &&
      ref_id == o.ref_id &&
      ref_type == o.ref_type &&
      second_party_id == o.second_party_id &&
      second_party_type == o.second_party_type &&
      tax == o.tax &&
      tax_reciever_id == o.tax_reciever_id
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 297

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



363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 363

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



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

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


263
264
265
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 263

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



269
270
271
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 269

def hash
  [amount, balance, date, extra_info, first_party_id, first_party_type, reason, ref_id, ref_type, second_party_id, second_party_type, tax, tax_reciever_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 179

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

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

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

  return 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



343
344
345
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 343

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



349
350
351
352
353
354
355
356
357
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 349

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



337
338
339
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 337

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



198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/esi-ruby/models/get_characters_character_id_wallet_journal_200_ok.rb', line 198

def valid?
  return false if @date.nil?
  first_party_type_validator = EnumAttributeValidator.new('String', ["character", "corporation", "alliance", "faction"])
  return false unless first_party_type_validator.valid?(@first_party_type)
  return false if @ref_id.nil?
  return false if @ref_type.nil?
  ref_type_validator = EnumAttributeValidator.new('String', ["player_trading", "market_transaction", "player_donation", "office_rental_fee", "bounty_prize_historical", "insurance", "mission_reward", "mission_reward_bonus", "cspa", "corp_account_withdrawal", "logo_change_fee", "market_escrow", "broker_fee", "alliance_maintenance_fee", "sales_tax", "jump_clone_installation_fee", "manufacturing", "contract", "bounty_prizes", "medal_creation_fee", "medal_issuing_fee", "customs_office_import_duty", "customs_office_export_duty", "corporate_reward_payout", "industry_facility_tax", "project_discovery_reward", "reprocessing_fee", "jump_clone_activation_fee", "unknown"])
  return false unless ref_type_validator.valid?(@ref_type)
  second_party_type_validator = EnumAttributeValidator.new('String', ["character", "corporation", "alliance", "faction"])
  return false unless second_party_type_validator.valid?(@second_party_type)
  return true
end