esi-sdk 2.0.0 → 2.1.0

data/lib/esi/client/planetary_interaction.rb

@@ -29,10 +29,38 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets_planet_id
       def get_character_planet(character_id:, planet_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/planets/#{planet_id}/", headers: headers, params: params).json
+        get_character_planet_raw(character_id: character_id, planet_id: planet_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_planets_planet_id get_character_planet
 
+      # 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 https://esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets_planet_id
+      def get_character_planet_raw(character_id:, planet_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/planets/#{planet_id}/", headers: headers, params: params)
+      end
+
       # Returns a list of all planetary colonies owned by a character.
       #
       # This endpoint is cached for up to 600 seconds.
@@ -59,10 +87,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets
       def get_character_planets(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/planets/", headers: headers, params: params).json
+        get_character_planets_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_planets get_character_planets
 
+      # 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 https://esi.evetech.net/ui/#/Planetary Interaction/get_characters_character_id_planets
+      def get_character_planets_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/planets/", headers: headers, params: params)
+      end
+
       # List customs offices owned by a corporation.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -89,11 +146,40 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Planetary Interaction/get_corporations_corporation_id_customs_offices
       def get_corporation_customs_offices(corporation_id:, headers: {}, params: {})
-        responses = get("/corporations/#{corporation_id}/customs_offices/", headers: headers, params: params)
+        responses = get_corporation_customs_offices_raw(corporation_id: corporation_id, headers: headers, params: params)
         responses.map(&:json).reduce([], :concat)
       end
       alias get_corporations_corporation_id_customs_offices get_corporation_customs_offices
 
+      # 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 https://esi.evetech.net/ui/#/Planetary Interaction/get_corporations_corporation_id_customs_offices
+      def get_corporation_customs_offices_raw(corporation_id:, headers: {}, params: {})
+        get("/corporations/#{corporation_id}/customs_offices/", headers: headers, params: params)
+      end
+
       # Get information on a planetary factory schematic.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -115,9 +201,33 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Planetary Interaction/get_universe_schematics_schematic_id
       def get_universe_schematic(schematic_id:, headers: {}, params: {})
-        get("/universe/schematics/#{schematic_id}/", headers: headers, params: params).json
+        get_universe_schematic_raw(schematic_id: schematic_id, headers: headers, params: params).json
       end
       alias get_universe_schematics_schematic_id get_universe_schematic
+
+      # 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 https://esi.evetech.net/ui/#/Planetary Interaction/get_universe_schematics_schematic_id
+      def get_universe_schematic_raw(schematic_id:, headers: {}, params: {})
+        get("/universe/schematics/#{schematic_id}/", headers: headers, params: params)
+      end
     end
   end
 end

data/lib/esi/client/routes.rb

@@ -29,8 +29,36 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Routes/get_route_origin_destination
       def get_route_origin_destination(destination:, origin:, avoid: nil, connections: nil, flag: "shortest", headers: {}, params: {})
+        get_route_origin_destination_raw(destination: destination, origin: origin, avoid: avoid, connections: connections, flag: flag, headers: headers, params: params).json
+      end
+
+      # Get the systems between origin and destination.
+      #
+      # This endpoint is cached for up to 86400 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param destination [Integer] destination solar system ID
+      # @param origin [Integer] origin solar system ID
+      # @param avoid [Array] avoid solar system ID(s)
+      # @param connections [Array] connected solar system pairs
+      # @param flag [String] route security preference. Must be one of: `shortest`, `secure`, `insecure`
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::NotFoundError] No route 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 https://esi.evetech.net/ui/#/Routes/get_route_origin_destination
+      def get_route_origin_destination_raw(destination:, origin:, avoid: nil, connections: nil, flag: "shortest", headers: {}, params: {})
         params.merge!("avoid" => avoid, "connections" => connections, "flag" => flag)
-        get("/route/#{origin}/#{destination}/", headers: headers, params: params).json
+        get("/route/#{origin}/#{destination}/", headers: headers, params: params)
       end
     end
   end

data/lib/esi/client/search.rb

@@ -33,11 +33,43 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Search/get_characters_character_id_search
       def get_character_search(character_id:, categories:, search:, strict: nil, headers: {}, params: {})
-        params.merge!("categories" => categories, "search" => search, "strict" => strict)
-        get("/characters/#{character_id}/search/", headers: headers, params: params).json
+        get_character_search_raw(character_id: character_id, categories: categories, search: search, strict: strict, headers: headers, params: params).json
       end
       alias get_characters_character_id_search get_character_search
 
+      # Search for entities that match a given sub-string.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-search.search_structures.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v3
+      #
+      # @param character_id [Integer] An EVE character ID
+      # @param categories [Array] Type of entities to search for
+      # @param search [String] The string to search on
+      # @param strict [Boolean] Whether the search should be a strict match
+      # @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 https://esi.evetech.net/ui/#/Search/get_characters_character_id_search
+      def get_character_search_raw(character_id:, categories:, search:, strict: nil, headers: {}, params: {})
+        params.merge!("categories" => categories, "search" => search, "strict" => strict)
+        get("/characters/#{character_id}/search/", headers: headers, params: params)
+      end
+
       # Search for entities that match a given sub-string.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -60,8 +92,33 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Search/get_search
       def get_search(categories:, search:, strict: nil, headers: {}, params: {})
+        get_search_raw(categories: categories, search: search, strict: strict, headers: headers, params: params).json
+      end
+
+      # Search for entities that match a given sub-string.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v2
+      #
+      # @param categories [Array] Type of entities to search for
+      # @param search [String] The string to search on
+      # @param strict [Boolean] Whether the search should be a strict match
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @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 https://esi.evetech.net/ui/#/Search/get_search
+      def get_search_raw(categories:, search:, strict: nil, headers: {}, params: {})
         params.merge!("categories" => categories, "search" => search, "strict" => strict)
-        get("/search/", headers: headers, params: params).json
+        get("/search/", headers: headers, params: params)
       end
     end
   end

data/lib/esi/client/skills.rb

@@ -30,10 +30,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Skills/get_characters_character_id_attributes
       def get_character_attributes(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/attributes/", headers: headers, params: params).json
+        get_character_attributes_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_attributes get_character_attributes
 
+      # Return attributes of a character.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-skills.read_skills.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 https://esi.evetech.net/ui/#/Skills/get_characters_character_id_attributes
+      def get_character_attributes_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/attributes/", headers: headers, params: params)
+      end
+
       # List the configured skill queue for the given character.
       #
       # This endpoint is cached for up to 120 seconds.
@@ -60,10 +89,39 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Skills/get_characters_character_id_skillqueue
       def get_character_skillqueue(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/skillqueue/", headers: headers, params: params).json
+        get_character_skillqueue_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_skillqueue get_character_skillqueue
 
+      # List the configured skill queue for the given character.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-skills.read_skillqueue.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v2
+      #
+      # @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 https://esi.evetech.net/ui/#/Skills/get_characters_character_id_skillqueue
+      def get_character_skillqueue_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/skillqueue/", headers: headers, params: params)
+      end
+
       # List all trained skills for the given character.
       #
       # This endpoint is cached for up to 120 seconds.
@@ -89,9 +147,37 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Skills/get_characters_character_id_skills
       def get_character_skills(character_id:, headers: {}, params: {})
-        get("/characters/#{character_id}/skills/", headers: headers, params: params).json
+        get_character_skills_raw(character_id: character_id, headers: headers, params: params).json
       end
       alias get_characters_character_id_skills get_character_skills
+
+      # List all trained skills for the given character.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-skills.read_skills.v1
+      #
+      # @esi_version dev
+      # @esi_version v4
+      #
+      # @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 https://esi.evetech.net/ui/#/Skills/get_characters_character_id_skills
+      def get_character_skills_raw(character_id:, headers: {}, params: {})
+        get("/characters/#{character_id}/skills/", headers: headers, params: params)
+      end
     end
   end
 end

data/lib/esi/client/sovereignty.rb

@@ -23,7 +23,29 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_campaigns
       def get_sovereignty_campaigns(headers: {}, params: {})
-        get("/sovereignty/campaigns/", headers: headers, params: params).json
+        get_sovereignty_campaigns_raw(headers: headers, params: params).json
+      end
+
+      # Shows sovereignty data for campaigns.
+      #
+      # This endpoint is cached for up to 5 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @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 https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_campaigns
+      def get_sovereignty_campaigns_raw(headers: {}, params: {})
+        get("/sovereignty/campaigns/", headers: headers, params: params)
       end
 
       # Shows sovereignty information for solar systems.
@@ -45,7 +67,29 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_map
       def get_sovereignty_map(headers: {}, params: {})
-        get("/sovereignty/map/", headers: headers, params: params).json
+        get_sovereignty_map_raw(headers: headers, params: params).json
+      end
+
+      # Shows sovereignty information for solar systems.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @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 https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_map
+      def get_sovereignty_map_raw(headers: {}, params: {})
+        get("/sovereignty/map/", headers: headers, params: params)
       end
 
       # Shows sovereignty data for structures.
@@ -67,7 +111,29 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_structures
       def get_sovereignty_structures(headers: {}, params: {})
-        get("/sovereignty/structures/", headers: headers, params: params).json
+        get_sovereignty_structures_raw(headers: headers, params: params).json
+      end
+
+      # Shows sovereignty data for structures.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @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 https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_structures
+      def get_sovereignty_structures_raw(headers: {}, params: {})
+        get("/sovereignty/structures/", headers: headers, params: params)
       end
     end
   end

data/lib/esi/client/status.rb

@@ -24,7 +24,30 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Status/get_status
       def get_status(headers: {}, params: {})
-        get("/status/", headers: headers, params: params).json
+        get_status_raw(headers: headers, params: params).json
+      end
+
+      # EVE Server status.
+      #
+      # This endpoint is cached for up to 30 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      # @esi_version v2
+      #
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @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 https://esi.evetech.net/ui/#/Status/get_status
+      def get_status_raw(headers: {}, params: {})
+        get("/status/", headers: headers, params: params)
       end
     end
   end