class ESIClient::AssetsApi
Attributes
Public Class Methods
# File lib/esi_client/api/assets_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get character assets Return a list of the characters assets — 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] :page Which page of results to return (default to 1) @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<GetCharactersCharacterIdAssets200Ok>]
# File lib/esi_client/api/assets_api.rb, line 32 def get_characters_character_id_assets(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_assets_with_http_info(character_id, opts) data end
Get character assets Return a list of the characters assets — 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] :page Which page of results to return @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<GetCharactersCharacterIdAssets200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdAssets200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 47 def get_characters_character_id_assets_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.get_characters_character_id_assets ...' 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 AssetsApi.get_characters_character_id_assets" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling AssetsApi.get_characters_character_id_assets, 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}/assets/'.sub('{' + 'character_id' + '}', character_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetCharactersCharacterIdAssets200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#get_characters_character_id_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get corporation assets Return a list of the corporation assets — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director — [This route has an available update](esi.tech.ccp.is/diff/latest/dev/#GET-/corporations/{corporation_id}/assets/) @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 [Integer] :page Which page of results to return (default to 1) @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<GetCorporationsCorporationIdAssets200Ok>]
# File lib/esi_client/api/assets_api.rb, line 106 def get_corporations_corporation_id_assets(corporation_id, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_assets_with_http_info(corporation_id, opts) data end
Get corporation assets Return a list of the corporation assets — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director — [This route has an available update](esi.tech.ccp.is/diff/latest/dev/#GET-/corporations/{corporation_id}/assets/) @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 [Integer] :page Which page of results to return @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<GetCorporationsCorporationIdAssets200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdAssets200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 121 def get_corporations_corporation_id_assets_with_http_info(corporation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.get_corporations_corporation_id_assets ...' 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 AssetsApi.get_corporations_corporation_id_assets" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling AssetsApi.get_corporations_corporation_id_assets, 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}/assets/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].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<GetCorporationsCorporationIdAssets200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#get_corporations_corporation_id_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character asset locations Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — @param character_id An EVE character ID @param item_ids A list of item ids @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<PostCharactersCharacterIdAssetsLocations200Ok>]
# File lib/esi_client/api/assets_api.rb, line 180 def post_characters_character_id_assets_locations(character_id, item_ids, opts = {}) data, _status_code, _headers = post_characters_character_id_assets_locations_with_http_info(character_id, item_ids, opts) data end
Get character asset locations Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — @param character_id An EVE character ID @param item_ids A list of item ids @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<PostCharactersCharacterIdAssetsLocations200Ok>, Fixnum, Hash)>] Array<PostCharactersCharacterIdAssetsLocations200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 195 def post_characters_character_id_assets_locations_with_http_info(character_id, item_ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.post_characters_character_id_assets_locations ...' 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 AssetsApi.post_characters_character_id_assets_locations" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling AssetsApi.post_characters_character_id_assets_locations, must be greater than or equal to 1.' end # verify the required parameter 'item_ids' is set if @api_client.config.client_side_validation && item_ids.nil? fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_characters_character_id_assets_locations" 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/characters/{character_id}/assets/locations/'.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 = @api_client.object_to_http_body(item_ids) auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:POST, 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<PostCharactersCharacterIdAssetsLocations200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#post_characters_character_id_assets_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get character asset names Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. — @param character_id An EVE character ID @param item_ids A list of item ids @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<PostCharactersCharacterIdAssetsNames200Ok>]
# File lib/esi_client/api/assets_api.rb, line 257 def post_characters_character_id_assets_names(character_id, item_ids, opts = {}) data, _status_code, _headers = post_characters_character_id_assets_names_with_http_info(character_id, item_ids, opts) data end
Get character asset names Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. — @param character_id An EVE character ID @param item_ids A list of item ids @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<PostCharactersCharacterIdAssetsNames200Ok>, Fixnum, Hash)>] Array<PostCharactersCharacterIdAssetsNames200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 272 def post_characters_character_id_assets_names_with_http_info(character_id, item_ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.post_characters_character_id_assets_names ...' 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 AssetsApi.post_characters_character_id_assets_names" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling AssetsApi.post_characters_character_id_assets_names, must be greater than or equal to 1.' end # verify the required parameter 'item_ids' is set if @api_client.config.client_side_validation && item_ids.nil? fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_characters_character_id_assets_names" 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}/assets/names/'.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 = @api_client.object_to_http_body(item_ids) auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:POST, 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<PostCharactersCharacterIdAssetsNames200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#post_characters_character_id_assets_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get corporation asset locations Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — Requires one of the following EVE corporation role(s): Director @param corporation_id An EVE corporation ID @param item_ids A list of item ids @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<PostCorporationsCorporationIdAssetsLocations200Ok>]
# File lib/esi_client/api/assets_api.rb, line 334 def post_corporations_corporation_id_assets_locations(corporation_id, item_ids, opts = {}) data, _status_code, _headers = post_corporations_corporation_id_assets_locations_with_http_info(corporation_id, item_ids, opts) data end
Get corporation asset locations Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — Requires one of the following EVE corporation role(s): Director @param corporation_id An EVE corporation ID @param item_ids A list of item ids @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<PostCorporationsCorporationIdAssetsLocations200Ok>, Fixnum, Hash)>] Array<PostCorporationsCorporationIdAssetsLocations200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 349 def post_corporations_corporation_id_assets_locations_with_http_info(corporation_id, item_ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.post_corporations_corporation_id_assets_locations ...' 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 AssetsApi.post_corporations_corporation_id_assets_locations" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling AssetsApi.post_corporations_corporation_id_assets_locations, must be greater than or equal to 1.' end # verify the required parameter 'item_ids' is set if @api_client.config.client_side_validation && item_ids.nil? fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_corporations_corporation_id_assets_locations" 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}/assets/locations/'.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 = @api_client.object_to_http_body(item_ids) auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:POST, 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<PostCorporationsCorporationIdAssetsLocations200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#post_corporations_corporation_id_assets_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get coporation asset names Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships. — Requires one of the following EVE corporation role(s): Director @param corporation_id An EVE corporation ID @param item_ids A list of item ids @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<PostCorporationsCorporationIdAssetsNames200Ok>]
# File lib/esi_client/api/assets_api.rb, line 411 def post_corporations_corporation_id_assets_names(corporation_id, item_ids, opts = {}) data, _status_code, _headers = post_corporations_corporation_id_assets_names_with_http_info(corporation_id, item_ids, opts) data end
Get coporation asset names Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships. — Requires one of the following EVE corporation role(s): Director @param corporation_id An EVE corporation ID @param item_ids A list of item ids @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<PostCorporationsCorporationIdAssetsNames200Ok>, Fixnum, Hash)>] Array<PostCorporationsCorporationIdAssetsNames200Ok> data, response status code and response headers
# File lib/esi_client/api/assets_api.rb, line 426 def post_corporations_corporation_id_assets_names_with_http_info(corporation_id, item_ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssetsApi.post_corporations_corporation_id_assets_names ...' 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 AssetsApi.post_corporations_corporation_id_assets_names" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling AssetsApi.post_corporations_corporation_id_assets_names, must be greater than or equal to 1.' end # verify the required parameter 'item_ids' is set if @api_client.config.client_side_validation && item_ids.nil? fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_corporations_corporation_id_assets_names" 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}/assets/names/'.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 = @api_client.object_to_http_body(item_ids) auth_names = ['evesso'] data, status_code, headers = @api_client.call_api(:POST, 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<PostCorporationsCorporationIdAssetsNames200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: AssetsApi#post_corporations_corporation_id_assets_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end