esi-sdk 1.1.1

data/lib/esi/client/industry.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI industry operations.
+    module Industry
+      # List industry jobs placed by a character.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_character_jobs.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer,String] An EVE character ID
+      # @param include_completed [Boolean] Whether to retrieve completed character industry jobs. Only includes jobs from the past 90 days
+      # @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/#/Industry/get_characters_character_id_industry_jobs
+      def get_character_industry_jobs(character_id:, include_completed:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["include_completed", include_completed]])
+        get("/characters/#{character_id}/industry/jobs/?#{query_string}", headers: headers, params: params)
+      end
+      alias get_characters_character_id_industry_jobs get_character_industry_jobs
+
+      # Paginated record of all mining done by a character for the past 30 days.
+      #
+      # This endpoint is cached for up to 600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_character_mining.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/#/Industry/get_characters_character_id_mining
+      def get_character_mining(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/mining/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_mining get_character_mining
+
+      # List industry jobs run by a corporation.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_corporation_jobs.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param include_completed [Boolean] Whether to retrieve completed corporation industry jobs. Only includes jobs from the past 90 days
+      # @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/#/Industry/get_corporations_corporation_id_industry_jobs
+      def get_corporation_industry_jobs(corporation_id:, include_completed:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["include_completed", include_completed]])
+        get("/corporations/#{corporation_id}/industry/jobs/?#{query_string}", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_industry_jobs get_corporation_industry_jobs
+
+      # Extraction timers for all moon chunks being extracted by refineries belonging to a corporation.
+      #
+      # This endpoint is cached for up to 1800 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_corporation_mining.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/#/Industry/get_corporation_corporation_id_mining_extractions
+      def get_corporation_mining_extractions(corporation_id:, params: {}, headers: {})
+        get("/corporation/#{corporation_id}/mining/extractions/", headers: headers, params: params)
+      end
+      alias get_corporation_corporation_id_mining_extractions get_corporation_mining_extractions
+
+      # Paginated record of all mining seen by an observer.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_corporation_mining.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param observer_id [Integer,String] A mining observer 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/#/Industry/get_corporation_corporation_id_mining_observers_observer_id
+      def get_corporation_mining_observer(corporation_id:, observer_id:, params: {}, headers: {})
+        get("/corporation/#{corporation_id}/mining/observers/#{observer_id}/", headers: headers, params: params)
+      end
+      alias get_corporation_corporation_id_mining_observers_observer_id get_corporation_mining_observer
+
+      # Paginated list of all entities capable of observing and recording mining for a corporation.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-industry.read_corporation_mining.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/#/Industry/get_corporation_corporation_id_mining_observers
+      def get_corporation_mining_observers(corporation_id:, params: {}, headers: {})
+        get("/corporation/#{corporation_id}/mining/observers/", headers: headers, params: params)
+      end
+      alias get_corporation_corporation_id_mining_observers get_corporation_mining_observers
+
+      # Return a list of industry facilities.
+      #
+      # 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/#/Industry/get_industry_facilities
+      def get_industry_facilities(params: {}, headers: {})
+        get("/industry/facilities/", headers: headers, params: params)
+      end
+
+      # Return cost indices 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/#/Industry/get_industry_systems
+      def get_industry_systems(params: {}, headers: {})
+        get("/industry/systems/", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client/insurance.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI insurance operations.
+    module Insurance
+      # Return available insurance levels for all ship types.
+      #
+      # 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/#/Insurance/get_insurance_prices
+      def get_insurance_prices(params: {}, headers: {})
+        get("/insurance/prices/", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client/killmails.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI killmails operations.
+    module Killmail
+      # Return a list of a character's kills and losses going back 90 days.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-killmails.read_killmails.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/#/Killmails/get_characters_character_id_killmails_recent
+      def get_character_killmails_recent(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/killmails/recent/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_killmails_recent get_character_killmails_recent
+
+      # Get a list of a corporation's kills and losses going back 90 days.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-killmails.read_corporation_killmails.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/#/Killmails/get_corporations_corporation_id_killmails_recent
+      def get_corporation_killmails_recent(corporation_id:, params: {}, headers: {})
+        get("/corporations/#{corporation_id}/killmails/recent/", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_killmails_recent get_corporation_killmails_recent
+
+      # Return a single killmail from its ID and hash.
+      #
+      # This endpoint is cached for up to 30758400 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param killmail_hash [Integer,String] The killmail hash for verification
+      # @param killmail_id [Integer,String] The killmail ID to be queried
+      # @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::UnprocessableEntityError] Invalid killmail_id and/or killmail_hash
+      # @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/#/Killmails/get_killmails_killmail_id_killmail_hash
+      def get_killmail_killmail_hash(killmail_hash:, killmail_id:, params: {}, headers: {})
+        get("/killmails/#{killmail_id}/#{killmail_hash}/", headers: headers, params: params)
+      end
+      alias get_killmail get_killmail_killmail_hash
+      alias get_killmails_killmail_id_killmail_hash get_killmail_killmail_hash
+    end
+  end
+end

data/lib/esi/client/location.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI location operations.
+    module Location
+      # Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable.
+      #
+      # This endpoint is cached for up to 5 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-location.read_location.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      # @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/#/Location/get_characters_character_id_location
+      def get_character_location(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/location/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_location get_character_location
+
+      # Checks if the character is currently online.
+      #
+      # This endpoint is cached for up to 60 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-location.read_online.v1
+      #
+      # @esi_version dev
+      # @esi_version v2
+      # @esi_version v3
+      #
+      # @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/#/Location/get_characters_character_id_online
+      def get_character_online(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/online/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_online get_character_online
+
+      # Get the current ship type, name and id.
+      #
+      # This endpoint is cached for up to 5 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-location.read_ship_type.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      # @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/#/Location/get_characters_character_id_ship
+      def get_character_ship(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/ship/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_ship get_character_ship
+    end
+  end
+end

data/lib/esi/client/loyalty.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI loyalty operations.
+    module Loyalty
+      # Return a list of loyalty points for all corporations the character has worked for.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-characters.read_loyalty.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/#/Loyalty/get_characters_character_id_loyalty_points
+      def get_character_loyalty_points(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/loyalty/points/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_loyalty_points get_character_loyalty_points
+
+      # Return a list of offers from a specific corporation's loyalty store.
+      #
+      # @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::NotFoundError] No loyalty point store found for the provided corporation
+      # @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/#/Loyalty/get_loyalty_stores_corporation_id_offers
+      def get_loyalty_stores_corporation_offers(corporation_id:, params: {}, headers: {})
+        get("/loyalty/stores/#{corporation_id}/offers/", headers: headers, params: params)
+      end
+      alias get_loyalty_stores_corporation_id_offers get_loyalty_stores_corporation_offers
+    end
+  end
+end