esi-sdk 1.1.1

data/lib/esi/client/planetary_interaction.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI planetary interaction operations.
+    module PlanetaryInteraction
+      # 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,String] An EVE character ID
+      # @param planet_id [Integer,String] 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(character_id:, planet_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/planets/#{planet_id}/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_planets_planet_id get_character_planet
+
+      # 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,String] 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(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/planets/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_planets get_character_planets
+
+      # 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,String] 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(corporation_id:, params: {}, headers: {})
+        get("/corporations/#{corporation_id}/customs_offices/", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_customs_offices get_corporation_customs_offices
+
+      # 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,String] 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(schematic_id:, params: {}, headers: {})
+        get("/universe/schematics/#{schematic_id}/", headers: headers, params: params)
+      end
+      alias get_universe_schematics_schematic_id get_universe_schematic
+    end
+  end
+end

data/lib/esi/client/routes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI routes operations.
+    module Route
+      # 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,String] destination solar system ID
+      # @param origin [Integer,String] 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
+      # @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(destination:, origin:, avoid:, connections:, flag:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["avoid", avoid], ["connections", connections], ["flag", flag]])
+        get("/route/#{origin}/#{destination}/?#{query_string}", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client/search.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI search operations.
+    module 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,String] 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(character_id:, categories:, search:, strict:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["categories", categories], ["search", search], ["strict", strict]])
+        get("/characters/#{character_id}/search/?#{query_string}", headers: headers, params: params)
+      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.
+      #
+      # @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(categories:, search:, strict:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["categories", categories], ["search", search], ["strict", strict]])
+        get("/search/?#{query_string}", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client/skills.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI skills operations.
+    module Skill
+      # 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,String] 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(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/attributes/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_attributes get_character_attributes
+
+      # 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,String] 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(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/skillqueue/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_skillqueue get_character_skillqueue
+
+      # 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,String] 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(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/skills/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_skills get_character_skills
+    end
+  end
+end

data/lib/esi/client/sovereignty.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI sovereignty operations.
+    module Sovereignty
+      # 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(params: {}, headers: {})
+        get("/sovereignty/campaigns/", headers: headers, params: params)
+      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(params: {}, headers: {})
+        get("/sovereignty/map/", headers: headers, params: params)
+      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(params: {}, headers: {})
+        get("/sovereignty/structures/", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client/status.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI status operations.
+    module Status
+      # 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(params: {}, headers: {})
+        get("/status/", headers: headers, params: params)
+      end
+    end
+  end
+end