class ESIClient::WalletApi
Attributes
Public Class Methods
# File lib/esi_client/api/wallet_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get a character's wallet balance Returns a character's wallet balance — This route is cached for up to 120 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Float]
# File lib/esi_client/api/wallet_api.rb, line 31 def get_characters_character_id_wallet(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_wallet_with_http_info(character_id, opts) data end
Get character wallet journal Retrieve character wallet journal — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdWalletJournal200Ok>]
# File lib/esi_client/api/wallet_api.rb, line 103 def get_characters_character_id_wallet_journal(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_wallet_journal_with_http_info(character_id, opts) data end
Get character wallet journal Retrieve character wallet journal — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdWalletJournal200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdWalletJournal200Ok> data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 118 def get_characters_character_id_wallet_journal_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_characters_character_id_wallet_journal ...' end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_journal" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet_journal, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v3/characters/{character_id}/wallet/journal/'.sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'from_id'] = opts[:'from_id'] if !opts[:'from_id'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdWalletJournal200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallet_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get wallet transactions Get wallet transactions of a character — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :from_id Only show transactions happened before the one referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdWalletTransactions200Ok>]
# File lib/esi_client/api/wallet_api.rb, line 177 def get_characters_character_id_wallet_transactions(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_wallet_transactions_with_http_info(character_id, opts) data end
Get wallet transactions Get wallet transactions of a character — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :from_id Only show transactions happened before the one referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdWalletTransactions200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdWalletTransactions200Ok> data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 192 def get_characters_character_id_wallet_transactions_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_characters_character_id_wallet_transactions ...' end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_transactions" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet_transactions, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/characters/{character_id}/wallet/transactions/'.sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'from_id'] = opts[:'from_id'] if !opts[:'from_id'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCharactersCharacterIdWalletTransactions200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallet_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a character's wallet balance Returns a character's wallet balance — This route is cached for up to 120 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 45 def get_characters_character_id_wallet_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_characters_character_id_wallet ...' end # verify the required parameter 'character_id' is set if @api_client.config.client_side_validation && character_id.nil? fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/characters/{character_id}/wallet/'.sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Float') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a corporation's wallet balance Get a corporation's wallets — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCorporationsCorporationIdWallets200Ok>]
# File lib/esi_client/api/wallet_api.rb, line 250 def get_corporations_corporation_id_wallets(corporation_id, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_wallets_with_http_info(corporation_id, opts) data end
Get corporation wallet journal Retrieve corporation wallet journal — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param division Wallet key of the division to fetch journals from @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>]
# File lib/esi_client/api/wallet_api.rb, line 323 def get_corporations_corporation_id_wallets_division_journal(corporation_id, division, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_wallets_division_journal_with_http_info(corporation_id, division, opts) data end
Get corporation wallet journal Retrieve corporation wallet journal — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param division Wallet key of the division to fetch journals from @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok> data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 339 def get_corporations_corporation_id_wallets_division_journal_with_http_info(corporation_id, division, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets_division_journal ...' end # verify the required parameter 'corporation_id' is set if @api_client.config.client_side_validation && corporation_id.nil? fail ArgumentError, "Missing the required parameter 'corporation_id' when calling WalletApi.get_corporations_corporation_id_wallets_division_journal" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, must be greater than or equal to 1.' end # verify the required parameter 'division' is set if @api_client.config.client_side_validation && division.nil? fail ArgumentError, "Missing the required parameter 'division' when calling WalletApi.get_corporations_corporation_id_wallets_division_journal" end if @api_client.config.client_side_validation && division > 7 fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, must be smaller than or equal to 7.' end if @api_client.config.client_side_validation && division < 1 fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v2/corporations/{corporation_id}/wallets/{division}/journal/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s).sub('{' + 'division' + '}', division.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'from_id'] = opts[:'from_id'] if !opts[:'from_id'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_corporations_corporation_id_wallets_division_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get corporation wallet transactions Get wallet transactions of a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param division Wallet key of the division to fetch journals from @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>]
# File lib/esi_client/api/wallet_api.rb, line 411 def get_corporations_corporation_id_wallets_division_transactions(corporation_id, division, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_wallets_division_transactions_with_http_info(corporation_id, division, opts) data end
Get corporation wallet transactions Get wallet transactions of a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param division Wallet key of the division to fetch journals from @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok> data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 427 def get_corporations_corporation_id_wallets_division_transactions_with_http_info(corporation_id, division, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets_division_transactions ...' end # verify the required parameter 'corporation_id' is set if @api_client.config.client_side_validation && corporation_id.nil? fail ArgumentError, "Missing the required parameter 'corporation_id' when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, must be greater than or equal to 1.' end # verify the required parameter 'division' is set if @api_client.config.client_side_validation && division.nil? fail ArgumentError, "Missing the required parameter 'division' when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions" end if @api_client.config.client_side_validation && division > 7 fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, must be smaller than or equal to 7.' end if @api_client.config.client_side_validation && division < 1 fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/corporations/{corporation_id}/wallets/{division}/transactions/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s).sub('{' + 'division' + '}', division.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'from_id'] = opts[:'from_id'] if !opts[:'from_id'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_corporations_corporation_id_wallets_division_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a corporation's wallet balance Get a corporation's wallets — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant @param corporation_id An EVE corporation ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCorporationsCorporationIdWallets200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdWallets200Ok> data, response status code and response headers
# File lib/esi_client/api/wallet_api.rb, line 264 def get_corporations_corporation_id_wallets_with_http_info(corporation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets ...' end # verify the required parameter 'corporation_id' is set if @api_client.config.client_side_validation && corporation_id.nil? fail ArgumentError, "Missing the required parameter 'corporation_id' when calling WalletApi.get_corporations_corporation_id_wallets" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource']) fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity' end # resource path local_var_path = '/v1/corporations/{corporation_id}/wallets/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil? query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil? # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<GetCorporationsCorporationIdWallets200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_corporations_corporation_id_wallets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end