Class: ESIClient::GetCharactersCharacterIdWalletJournal200Ok

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



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_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 118

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

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



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

def amount
  @amount
end

#balance ⇒ Object

Wallet balance after transaction occurred



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

def balance
  @balance
end

#date ⇒ Object

Date and time of transaction



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

def date
  @date
end

#extra_info ⇒ Object

Returns the value of attribute extra_info.



54
55
56
 
# File 'lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 54

def extra_info
  @extra_info
end

#first_party_id ⇒ Object

first_party_id integer



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

def first_party_id
  @first_party_id
end

#first_party_type ⇒ Object

first_party_type string



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

def first_party_type
  @first_party_type
end

#reason ⇒ Object

reason string



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

def reason
  @reason
end

#ref_id ⇒ Object

Unique journal reference ID



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

def ref_id
  @ref_id
end

#ref_type ⇒ Object

Transaction type, different type of transaction will populate different fields in ‘extra_info` 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 use the following gist to see string->int mappings: gist.github.com/ccp-zoetrope/c03db66d90c2148724c06171bc52e0ec



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

def ref_type
  @ref_type
end

#second_party_id ⇒ Object

second_party_id integer



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

def second_party_id
  @second_party_id
end

#second_party_type ⇒ Object

second_party_type string



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

def second_party_type
  @second_party_type
end

#tax ⇒ Object

Tax amount received for tax related transactions



52
53
54
 
# File 'lib/esi_client/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



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

def tax_receiver_id
  @tax_receiver_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'date' => :'DateTime',
    :'ref_id' => :'Integer',
    :'ref_type' => :'String',
    :'first_party_id' => :'Integer',
    :'first_party_type' => :'String',
    :'second_party_id' => :'Integer',
    :'second_party_type' => :'String',
    :'amount' => :'Float',
    :'balance' => :'Float',
    :'reason' => :'String',
    :'tax_receiver_id' => :'Integer',
    :'tax' => :'Float',
    :'extra_info' => :'GetCharactersCharacterIdWalletJournalExtraInfo'
  }
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_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      ref_id == o.ref_id &&
      ref_type == o.ref_type &&
      first_party_id == o.first_party_id &&
      first_party_type == o.first_party_type &&
      second_party_id == o.second_party_id &&
      second_party_type == o.second_party_type &&
      amount == o.amount &&
      balance == o.balance &&
      reason == o.reason &&
      tax_receiver_id == o.tax_receiver_id &&
      tax == o.tax &&
      extra_info == o.extra_info
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_client/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_client/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_client/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_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 269

def hash
  [date, ref_id, ref_type, first_party_id, first_party_type, second_party_id, second_party_type, amount, balance, reason, tax_receiver_id, tax, extra_info].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/esi_client/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

  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



343
344
345
 
# File 'lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 343

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



349
350
351
352
353
354
355
356
357
 
# File 'lib/esi_client/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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



337
338
339
 
# File 'lib/esi_client/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_client/models/get_characters_character_id_wallet_journal_200_ok.rb', line 198

def valid?
  return false if @date.nil?
  return false if @ref_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', 'transaction_tax', 'upkeep_adjustment_fee', 'war_ally_contract', 'war_fee', 'war_fee_surrender'])
  return false unless ref_type_validator.valid?(@ref_type)
  first_party_type_validator = EnumAttributeValidator.new('String', ['character', 'corporation', 'alliance', 'faction', 'system'])
  return false unless first_party_type_validator.valid?(@first_party_type)
  second_party_type_validator = EnumAttributeValidator.new('String', ['character', 'corporation', 'alliance', 'faction', 'system'])
  return false unless second_party_type_validator.valid?(@second_party_type)
  true
end