class EsiClient::WalletApi
Attributes
Public Class Methods
# File lib/esi-ruby/api/wallet_api.rb, line 18 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 — Alternate route: `/v1/characters/{character_id}/wallet/` Alternate route: `/legacy/characters/{character_id}/wallet/` Alternate route: `/dev/characters/{character_id}/wallet/` — 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-ruby/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) return data end
Get character wallet journal Retrieve character wallet journal — Alternate route: `/v1/characters/{character_id}/wallet/journal/` Alternate route: `/legacy/characters/{character_id}/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-ruby/api/wallet_api.rb, line 98 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) return data end
Get character wallet journal Retrieve character wallet journal — Alternate route: `/v1/characters/{character_id}/wallet/journal/` Alternate route: `/legacy/characters/{character_id}/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-ruby/api/wallet_api.rb, line 113 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_journal" if character_id.nil? if 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 = "/characters/{character_id}/wallet/journal/".sub('{format}','json').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 — Alternate route: `/v1/characters/{character_id}/wallet/transactions/` Alternate route: `/legacy/characters/{character_id}/wallet/transactions/` Alternate route: `/dev/characters/{character_id}/wallet/transactions/` — 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-ruby/api/wallet_api.rb, line 167 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) return data end
Get wallet transactions Get wallet transactions of a character — Alternate route: `/v1/characters/{character_id}/wallet/transactions/` Alternate route: `/legacy/characters/{character_id}/wallet/transactions/` Alternate route: `/dev/characters/{character_id}/wallet/transactions/` — 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-ruby/api/wallet_api.rb, line 182 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 fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_transactions" if character_id.nil? if 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 = "/characters/{character_id}/wallet/transactions/".sub('{format}','json').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 — Alternate route: `/v1/characters/{character_id}/wallet/` Alternate route: `/legacy/characters/{character_id}/wallet/` Alternate route: `/dev/characters/{character_id}/wallet/` — 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-ruby/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 fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet" if character_id.nil? if 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 = "/characters/{character_id}/wallet/".sub('{format}','json').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
List wallets and balances List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet. — Alternate route: `/v1/characters/{character_id}/wallets/` Alternate route: `/legacy/characters/{character_id}/wallets/` — This route is cached for up to 120 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/{character_id}/wallet, this route will be removed on 2017-07-31. @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 [Array<GetCharactersCharacterIdWallets200Ok>]
# File lib/esi-ruby/api/wallet_api.rb, line 235 def get_characters_character_id_wallets(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_wallets_with_http_info(character_id, opts) return data end
Get character wallet journal Retrieve character wallet journal — Alternate route: `/v1/characters/{character_id}/wallets/journal/` Alternate route: `/legacy/characters/{character_id}/wallets/journal/` — This route is cached for up to 3600 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/{character_id}/wallet/journal, this route will be removed on 2017-07-31. @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<GetCharactersCharacterIdWalletsJournal200Ok>]
# File lib/esi-ruby/api/wallet_api.rb, line 302 def get_characters_character_id_wallets_journal(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_wallets_journal_with_http_info(character_id, opts) return data end
Get character wallet journal Retrieve character wallet journal — Alternate route: `/v1/characters/{character_id}/wallets/journal/` Alternate route: `/legacy/characters/{character_id}/wallets/journal/` — This route is cached for up to 3600 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/{character_id}/wallet/journal, this route will be removed on 2017-07-31. @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<GetCharactersCharacterIdWalletsJournal200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdWalletsJournal200Ok> data, response status code and response headers
# File lib/esi-ruby/api/wallet_api.rb, line 317 def get_characters_character_id_wallets_journal_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallets_journal ..." end # verify the required parameter 'character_id' is set fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallets_journal" if character_id.nil? if 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 = "/characters/{character_id}/wallets/journal/".sub('{format}','json').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<GetCharactersCharacterIdWalletsJournal200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallets_journal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List wallets and balances List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet. — Alternate route: `/v1/characters/{character_id}/wallets/` Alternate route: `/legacy/characters/{character_id}/wallets/` — This route is cached for up to 120 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/{character_id}/wallet, this route will be removed on 2017-07-31. @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<(Array<GetCharactersCharacterIdWallets200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdWallets200Ok> data, response status code and response headers
# File lib/esi-ruby/api/wallet_api.rb, line 249 def get_characters_character_id_wallets_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallets ..." end # verify the required parameter 'character_id' is set fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallets" if character_id.nil? if 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 = "/characters/{character_id}/wallets/".sub('{format}','json').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 => 'Array<GetCharactersCharacterIdWallets200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end