class ESIClient::PlanetaryInteractionApi
Attributes
Public Class Methods
# File lib/esi_client/api/planetary_interaction_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get colonies Returns a list of all planetary colonies owned by a character. — This route is cached for up to 600 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 [Array<GetCharactersCharacterIdPlanets200Ok>]
# File lib/esi_client/api/planetary_interaction_api.rb, line 31 def get_characters_character_id_planets(character_id, opts = {}) data, _status_code, _headers = get_characters_character_id_planets_with_http_info(character_id, opts) data end
Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. — This route is cached for up to 600 seconds @param character_id An EVE character ID @param planet_id Planet id of the target planet @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 [GetCharactersCharacterIdPlanetsPlanetIdOk]
# File lib/esi_client/api/planetary_interaction_api.rb, line 103 def get_characters_character_id_planets_planet_id(character_id, planet_id, opts = {}) data, _status_code, _headers = get_characters_character_id_planets_planet_id_with_http_info(character_id, planet_id, opts) data end
Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. — This route is cached for up to 600 seconds @param character_id An EVE character ID @param planet_id Planet id of the target planet @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<(GetCharactersCharacterIdPlanetsPlanetIdOk
, Fixnum, Hash)>] GetCharactersCharacterIdPlanetsPlanetIdOk
data, response status code and response headers
# File lib/esi_client/api/planetary_interaction_api.rb, line 118 def get_characters_character_id_planets_planet_id_with_http_info(character_id, planet_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlanetaryInteractionApi.get_characters_character_id_planets_planet_id ...' 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 PlanetaryInteractionApi.get_characters_character_id_planets_planet_id" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling PlanetaryInteractionApi.get_characters_character_id_planets_planet_id, must be greater than or equal to 1.' end # verify the required parameter 'planet_id' is set if @api_client.config.client_side_validation && planet_id.nil? fail ArgumentError, "Missing the required parameter 'planet_id' when calling PlanetaryInteractionApi.get_characters_character_id_planets_planet_id" 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}/planets/{planet_id}/'.sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'planet_id' + '}', planet_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 => 'GetCharactersCharacterIdPlanetsPlanetIdOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: PlanetaryInteractionApi#get_characters_character_id_planets_planet_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get colonies Returns a list of all planetary colonies owned by a character. — This route is cached for up to 600 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<(Array<GetCharactersCharacterIdPlanets200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdPlanets200Ok> data, response status code and response headers
# File lib/esi_client/api/planetary_interaction_api.rb, line 45 def get_characters_character_id_planets_with_http_info(character_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlanetaryInteractionApi.get_characters_character_id_planets ...' 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 PlanetaryInteractionApi.get_characters_character_id_planets" end if @api_client.config.client_side_validation && character_id < 1 fail ArgumentError, 'invalid value for "character_id" when calling PlanetaryInteractionApi.get_characters_character_id_planets, 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}/planets/'.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<GetCharactersCharacterIdPlanets200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PlanetaryInteractionApi#get_characters_character_id_planets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List corporation customs offices List customs offices owned by a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director @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<GetCorporationsCorporationIdCustomsOffices200Ok>]
# File lib/esi_client/api/planetary_interaction_api.rb, line 180 def get_corporations_corporation_id_customs_offices(corporation_id, opts = {}) data, _status_code, _headers = get_corporations_corporation_id_customs_offices_with_http_info(corporation_id, opts) data end
List corporation customs offices List customs offices owned by a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director @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<GetCorporationsCorporationIdCustomsOffices200Ok>, Fixnum, Hash)>] Array<GetCorporationsCorporationIdCustomsOffices200Ok> data, response status code and response headers
# File lib/esi_client/api/planetary_interaction_api.rb, line 195 def get_corporations_corporation_id_customs_offices_with_http_info(corporation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlanetaryInteractionApi.get_corporations_corporation_id_customs_offices ...' 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 PlanetaryInteractionApi.get_corporations_corporation_id_customs_offices" end if @api_client.config.client_side_validation && corporation_id < 1 fail ArgumentError, 'invalid value for "corporation_id" when calling PlanetaryInteractionApi.get_corporations_corporation_id_customs_offices, 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}/customs_offices/'.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<GetCorporationsCorporationIdCustomsOffices200Ok>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PlanetaryInteractionApi#get_corporations_corporation_id_customs_offices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get schematic information Get information on a planetary factory schematic — This route is cached for up to 3600 seconds @param schematic_id A PI schematic 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] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetUniverseSchematicsSchematicIdOk]
# File lib/esi_client/api/planetary_interaction_api.rb, line 252 def get_universe_schematics_schematic_id(schematic_id, opts = {}) data, _status_code, _headers = get_universe_schematics_schematic_id_with_http_info(schematic_id, opts) data end
Get schematic information Get information on a planetary factory schematic — This route is cached for up to 3600 seconds @param schematic_id A PI schematic ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @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<(GetUniverseSchematicsSchematicIdOk
, Fixnum, Hash)>] GetUniverseSchematicsSchematicIdOk
data, response status code and response headers
# File lib/esi_client/api/planetary_interaction_api.rb, line 265 def get_universe_schematics_schematic_id_with_http_info(schematic_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlanetaryInteractionApi.get_universe_schematics_schematic_id ...' end # verify the required parameter 'schematic_id' is set if @api_client.config.client_side_validation && schematic_id.nil? fail ArgumentError, "Missing the required parameter 'schematic_id' when calling PlanetaryInteractionApi.get_universe_schematics_schematic_id" 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/universe/schematics/{schematic_id}/'.sub('{' + 'schematic_id' + '}', schematic_id.to_s) # query parameters query_params = {} query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = [] 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 => 'GetUniverseSchematicsSchematicIdOk') if @api_client.config.debugging @api_client.config.logger.debug "API called: PlanetaryInteractionApi#get_universe_schematics_schematic_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end