Class: ESI::GetCharactersCharacterIdWalletJournal200Ok

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



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
176
177
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 119

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

The amount of ISK given or taken from the wallet as a result of the given transaction. Positive when ISK is deposited into the wallet and negative when ISK is withdrawn



19
20
21
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 19

def amount
  @amount
end

#balance ⇒ Object

Wallet balance after transaction occurred



22
23
24
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 22

def balance
  @balance
end

#context_id ⇒ Object

An ID that gives extra context to the particular transaction. Because of legacy reasons the context is completely different per ref_type and means different things. It is also possible to not have a context_id



25
26
27
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 25

def context_id
  @context_id
end

#context_id_type ⇒ Object

The type of the given context_id if present



28
29
30
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 28

def context_id_type
  @context_id_type
end

#date ⇒ Object

Date and time of transaction



31
32
33
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 31

def date
  @date
end

#description ⇒ Object

The reason for the transaction, mirrors what is seen in the client



34
35
36
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 34

def description
  @description
end

#first_party_id ⇒ Object

The id of the first party involved in the transaction. This attribute has no consistency and is different or non existant for particular ref_types. The description attribute will help make sense of what this attribute means. For more info about the given ID it can be dropped into the /universe/names/ ESI route to determine its type and name



37
38
39
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 37

def first_party_id
  @first_party_id
end

#id ⇒ Object

Unique journal reference ID



40
41
42
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 40

def id
  @id
end

#reason ⇒ Object

The user stated reason for the transaction. Only applies to some ref_types



43
44
45
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 43

def reason
  @reason
end

#ref_type ⇒ Object

"The transaction type for the given. transaction. Different transaction types will populate different attributes. Note: If you have an existing XML API application that is using ref_types, you will need to know which string ESI ref_type maps to which integer. You can look at the following file to see string->int mappings: github.com/ccpgames/eve-glue/blob/master/eve_glue/wallet_journal_ref.py"



46
47
48
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 46

def ref_type
  @ref_type
end

#second_party_id ⇒ Object

The id of the second party involved in the transaction. This attribute has no consistency and is different or non existant for particular ref_types. The description attribute will help make sense of what this attribute means. For more info about the given ID it can be dropped into the /universe/names/ ESI route to determine its type and name



49
50
51
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 49

def second_party_id
  @second_party_id
end

#tax ⇒ Object

Tax amount received. Only applies to tax related transactions



52
53
54
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 52

def tax
  @tax
end

#tax_receiver_id ⇒ Object

The corporation ID receiving any tax paid. Only applies to tax related transactions



55
56
57
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 55

def tax_receiver_id
  @tax_receiver_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'amount' => :'amount',
    :'balance' => :'balance',
    :'context_id' => :'context_id',
    :'context_id_type' => :'context_id_type',
    :'date' => :'date',
    :'description' => :'description',
    :'first_party_id' => :'first_party_id',
    :'id' => :'id',
    :'reason' => :'reason',
    :'ref_type' => :'ref_type',
    :'second_party_id' => :'second_party_id',
    :'tax' => :'tax',
    :'tax_receiver_id' => :'tax_receiver_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'amount' => :'Float',
    :'balance' => :'Float',
    :'context_id' => :'Integer',
    :'context_id_type' => :'String',
    :'date' => :'DateTime',
    :'description' => :'String',
    :'first_party_id' => :'Integer',
    :'id' => :'Integer',
    :'reason' => :'String',
    :'ref_type' => :'String',
    :'second_party_id' => :'Integer',
    :'tax' => :'Float',
    :'tax_receiver_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      balance == o.balance &&
      context_id == o.context_id &&
      context_id_type == o.context_id_type &&
      date == o.date &&
      description == o.description &&
      first_party_id == o.first_party_id &&
      id == o.id &&
      reason == o.reason &&
      ref_type == o.ref_type &&
      second_party_id == o.second_party_id &&
      tax == o.tax &&
      tax_receiver_id == o.tax_receiver_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



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
321
322
323
324
325
326
327
328
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 292

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 = ESI.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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 358

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 271

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


258
259
260
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 264

def hash
  [amount, balance, context_id, context_id_type, date, description, first_party_id, id, reason, ref_type, second_party_id, tax, tax_receiver_id].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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 181

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

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 338

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



344
345
346
347
348
349
350
351
352
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 344

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



332
333
334
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 332

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



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/esi-client-bvv/models/get_characters_character_id_wallet_journal_200_ok.rb', line 204

def valid?
  context_id_type_validator = EnumAttributeValidator.new('String', ["structure_id", "station_id", "market_transaction_id", "character_id", "corporation_id", "alliance_id", "eve_system", "industry_job_id", "contract_id", "planet_id", "system_id", "type_id"])
  return false unless context_id_type_validator.valid?(@context_id_type)
  return false if @date.nil?
  return false if @description.nil?
  return false if @id.nil?
  return false if @ref_type.nil?
  ref_type_validator = EnumAttributeValidator.new('String', ["acceleration_gate_fee", "advertisement_listing_fee", "agent_donation", "agent_location_services", "agent_miscellaneous", "agent_mission_collateral_paid", "agent_mission_collateral_refunded", "agent_mission_reward", "agent_mission_reward_corporation_tax", "agent_mission_time_bonus_reward", "agent_mission_time_bonus_reward_corporation_tax", "agent_security_services", "agent_services_rendered", "agents_preward", "alliance_maintainance_fee", "alliance_registration_fee", "asset_safety_recovery_tax", "bounty", "bounty_prize", "bounty_prize_corporation_tax", "bounty_prizes", "bounty_reimbursement", "bounty_surcharge", "brokers_fee", "clone_activation", "clone_transfer", "contraband_fine", "contract_auction_bid", "contract_auction_bid_corp", "contract_auction_bid_refund", "contract_auction_sold", "contract_brokers_fee", "contract_brokers_fee_corp", "contract_collateral", "contract_collateral_deposited_corp", "contract_collateral_payout", "contract_collateral_refund", "contract_deposit", "contract_deposit_corp", "contract_deposit_refund", "contract_deposit_sales_tax", "contract_price", "contract_price_payment_corp", "contract_reversal", "contract_reward", "contract_reward_deposited", "contract_reward_deposited_corp", "contract_reward_refund", "contract_sales_tax", "copying", "corporate_reward_payout", "corporate_reward_tax", "corporation_account_withdrawal", "corporation_bulk_payment", "corporation_dividend_payment", "corporation_liquidation", "corporation_logo_change_cost", "corporation_payment", "corporation_registration_fee", "courier_mission_escrow", "cspa", "cspaofflinerefund", "datacore_fee", "dna_modification_fee", "docking_fee", "duel_wager_escrow", "duel_wager_payment", "duel_wager_refund", "factory_slot_rental_fee", "gm_cash_transfer", "industry_job_tax", "infrastructure_hub_maintenance", "inheritance", "insurance", "jump_clone_activation_fee", "jump_clone_installation_fee", "kill_right_fee", "lp_store", "manufacturing", "market_escrow", "market_fine_paid", "market_transaction", "medal_creation", "medal_issued", "mission_completion", "mission_cost", "mission_expiration", "mission_reward", "office_rental_fee", "operation_bonus", "opportunity_reward", "planetary_construction", "planetary_export_tax", "planetary_import_tax", "player_donation", "player_trading", "project_discovery_reward", "project_discovery_tax", "reaction", "release_of_impounded_property", "repair_bill", "reprocessing_tax", "researching_material_productivity", "researching_technology", "researching_time_productivity", "resource_wars_reward", "reverse_engineering", "security_processing_fee", "shares", "sovereignity_bill", "store_purchase", "store_purchase_refund", "structure_gate_jump", "transaction_tax", "upkeep_adjustment_fee", "war_ally_contract", "war_fee", "war_fee_surrender"])
  return false unless ref_type_validator.valid?(@ref_type)
  return true
end