class ESIClient::GetCharactersCharacterIdWalletJournal200Ok

200 ok object

Attributes

amount[RW]

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

balance[RW]

Wallet balance after transaction occurred

date[RW]

Date and time of transaction

extra_info[RW]
first_party_id[RW]

first_party_id integer

first_party_type[RW]
reason[RW]

reason string

ref_id[RW]

Unique journal reference ID

ref_type[RW]

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

second_party_id[RW]

second_party_id integer

second_party_type[RW]
tax[RW]

Tax amount received for tax related transactions

tax_receiver_id[RW]

the corporation ID receiving any tax paid

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb, line 263
def eql?(o)
  self == o
end
first_party_type=(first_party_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] first_party_type Object to be assigned

# File lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb, line 223
def first_party_type=(first_party_type)
  validator = EnumAttributeValidator.new('String', ['character', 'corporation', 'alliance', 'faction', 'system'])
  unless validator.valid?(first_party_type)
    fail ArgumentError, 'invalid value for "first_party_type", must be one of #{validator.allowable_values}.'
  end
  @first_party_type = first_party_type
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
ref_type=(ref_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] ref_type Object to be assigned

# File lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb, line 213
def ref_type=(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'])
  unless validator.valid?(ref_type)
    fail ArgumentError, 'invalid value for "ref_type", must be one of #{validator.allowable_values}.'
  end
  @ref_type = ref_type
end
second_party_type=(second_party_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] second_party_type Object to be assigned

# File lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb, line 233
def second_party_type=(second_party_type)
  validator = EnumAttributeValidator.new('String', ['character', 'corporation', 'alliance', 'faction', 'system'])
  unless validator.valid?(second_party_type)
    fail ArgumentError, 'invalid value for "second_party_type", must be one of #{validator.allowable_values}.'
  end
  @second_party_type = second_party_type
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/esi_client/models/get_characters_character_id_wallet_journal_200_ok.rb, line 343
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# 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?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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