module ESI::Client::PlanetaryInteraction

ESI planetary interaction operations.

Public Instance Methods

get_character_planet(character_id:, planet_id:, headers: {}, params: {}) click to toggle source

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 endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-planets.manage_planets.v1

@esi_version dev @esi_version v3

@param character_id [Integer] An EVE character ID @param planet_id [Integer] Planet id of the target planet @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::NotFoundError] Colony not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets_planet_id

# File lib/esi/client/planetary_interaction.rb, line 31
def get_character_planet(character_id:, planet_id:, headers: {}, params: {})
  get("/characters/#{character_id}/planets/#{planet_id}/", headers: headers, params: params)
end
get_character_planets(character_id:, headers: {}, params: {}) click to toggle source

Returns a list of all planetary colonies owned by a character.

This endpoint is cached for up to 600 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-planets.manage_planets.v1

@esi_version dev @esi_version legacy @esi_version v1

@param character_id [Integer] An EVE character ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets

# File lib/esi/client/planetary_interaction.rb, line 61
def get_character_planets(character_id:, headers: {}, params: {})
  get("/characters/#{character_id}/planets/", headers: headers, params: params)
end
get_characters_character_id_planets(character_id:, headers: {}, params: {})
get_characters_character_id_planets_planet_id(character_id:, planet_id:, headers: {}, params: {})
get_corporation_customs_offices(corporation_id:, headers: {}, params: {}) click to toggle source

List customs offices owned by a corporation.

This endpoint is cached for up to 3600 seconds.

This endpoint requires authorization (see {ESI::Client#authorize}).

@esi_scope esi-planets.read_customs_offices.v1

@esi_version dev @esi_version legacy @esi_version v1

@param corporation_id [Integer] An EVE corporation ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::UnauthorizedError] Unauthorized @raise [ESI::Errors::ForbiddenError] Forbidden @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Planetary Interaction/get_corporations_corporation_id_customs_offices

# File lib/esi/client/planetary_interaction.rb, line 91
def get_corporation_customs_offices(corporation_id:, headers: {}, params: {})
  get("/corporations/#{corporation_id}/customs_offices/", headers: headers, params: params)
end
get_corporations_corporation_id_customs_offices(corporation_id:, headers: {}, params: {})
get_universe_schematic(schematic_id:, headers: {}, params: {}) click to toggle source

Get information on a planetary factory schematic.

This endpoint is cached for up to 3600 seconds.

@esi_version dev @esi_version legacy @esi_version v1

@param schematic_id [Integer] A PI schematic ID @param params [Hash] Additional query string parameters @param headers [Hash] Additional headers

@raise [ESI::Errors::BadRequestError] Bad request @raise [ESI::Errors::NotFoundError] Schematic not found @raise [ESI::Errors::ErrorLimitedError] Error limited @raise [ESI::Errors::InternalServerError] Internal server error @raise [ESI::Errors::ServiceUnavailableError] Service unavailable @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout

@see esi.evetech.net/ui/#/Planetary Interaction/get_universe_schematics_schematic_id

# File lib/esi/client/planetary_interaction.rb, line 116
def get_universe_schematic(schematic_id:, headers: {}, params: {})
  get("/universe/schematics/#{schematic_id}/", headers: headers, params: params)
end
get_universe_schematics_schematic_id(schematic_id:, headers: {}, params: {})