esi-sdk 1.1.3 → 1.2.0

data/lib/esi/client/market.rb

@@ -15,7 +15,7 @@ module ESI
       # @esi_version dev
       # @esi_version v2
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -28,7 +28,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_characters_character_id_orders
-      def get_character_orders(character_id:, params: {}, headers: {})
+      def get_character_orders(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/orders/", headers: headers, params: params)
       end
       alias get_characters_character_id_orders get_character_orders
@@ -45,7 +45,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -58,7 +58,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_characters_character_id_orders_history
-      def get_character_orders_history(character_id:, params: {}, headers: {})
+      def get_character_orders_history(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/orders/history/", headers: headers, params: params)
       end
       alias get_characters_character_id_orders_history get_character_orders_history
@@ -74,7 +74,7 @@ module ESI
       # @esi_version dev
       # @esi_version v3
       #
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -87,7 +87,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_corporations_corporation_id_orders
-      def get_corporation_orders(corporation_id:, params: {}, headers: {})
+      def get_corporation_orders(corporation_id:, headers: {}, params: {})
         get("/corporations/#{corporation_id}/orders/", headers: headers, params: params)
       end
       alias get_corporations_corporation_id_orders get_corporation_orders
@@ -103,7 +103,7 @@ module ESI
       # @esi_version dev
       # @esi_version v2
       #
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -116,7 +116,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_corporations_corporation_id_orders_history
-      def get_corporation_orders_history(corporation_id:, params: {}, headers: {})
+      def get_corporation_orders_history(corporation_id:, headers: {}, params: {})
         get("/corporations/#{corporation_id}/orders/history/", headers: headers, params: params)
       end
       alias get_corporations_corporation_id_orders_history get_corporation_orders_history
@@ -137,7 +137,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_groups
-      def get_market_groups(params: {}, headers: {})
+      def get_market_groups(headers: {}, params: {})
         get("/markets/groups/", headers: headers, params: params)
       end
       alias get_markets_groups get_market_groups
@@ -148,7 +148,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param market_group_id [Integer,String] An Eve item group ID
+      # @param market_group_id [Integer] An Eve item group ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -160,7 +160,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_groups_market_group_id
-      def get_market_groups_market_group(market_group_id:, params: {}, headers: {})
+      def get_market_groups_market_group(market_group_id:, headers: {}, params: {})
         get("/markets/groups/#{market_group_id}/", headers: headers, params: params)
       end
       alias get_markets_groups_market_group_id get_market_groups_market_group
@@ -183,7 +183,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_prices
-      def get_market_prices(params: {}, headers: {})
+      def get_market_prices(headers: {}, params: {})
         get("/markets/prices/", headers: headers, params: params)
       end
       alias get_markets_prices get_market_prices
@@ -194,7 +194,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param region_id [Integer,String] Return statistics in this region
+      # @param region_id [Integer] Return statistics in this region
       # @param type_id [Integer] Return statistics for this type
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
@@ -209,9 +209,9 @@ module ESI
       # @raise [ESI::Errors::EveServerError] Internal error thrown from the EVE server
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_history
-      def get_markets_region_history(region_id:, type_id:, params: {}, headers: {})
-        query_string = URI.encode_www_form([["type_id", type_id]])
-        get("/markets/#{region_id}/history/?#{query_string}", headers: headers, params: params)
+      def get_markets_region_history(region_id:, type_id:, headers: {}, params: {})
+        params.merge!("type_id" => type_id)
+        get("/markets/#{region_id}/history/", headers: headers, params: params)
       end
       alias get_markets_region_id_history get_markets_region_history
 
@@ -223,8 +223,8 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param region_id [Integer,String] Return orders in this region
-      # @param order_type [String] Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders
+      # @param region_id [Integer] Return orders in this region
+      # @param order_type [String] Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders. Must be one of: `buy`, `sell`, `all`
       # @param type_id [Integer] Return orders only for this type
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
@@ -238,9 +238,9 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_orders
-      def get_markets_region_orders(region_id:, order_type:, type_id:, params: {}, headers: {})
-        query_string = URI.encode_www_form([["order_type", order_type], ["type_id", type_id]])
-        get("/markets/#{region_id}/orders/?#{query_string}", headers: headers, params: params)
+      def get_markets_region_orders(region_id:, order_type: "all", type_id: nil, headers: {}, params: {})
+        params.merge!("order_type" => order_type, "type_id" => type_id)
+        get("/markets/#{region_id}/orders/", headers: headers, params: params)
       end
       alias get_markets_region_id_orders get_markets_region_orders
 
@@ -252,7 +252,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param region_id [Integer,String] Return statistics in this region
+      # @param region_id [Integer] Return statistics in this region
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -263,7 +263,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_region_id_types
-      def get_markets_region_types(region_id:, params: {}, headers: {})
+      def get_markets_region_types(region_id:, headers: {}, params: {})
         get("/markets/#{region_id}/types/", headers: headers, params: params)
       end
       alias get_markets_region_id_types get_markets_region_types
@@ -280,7 +280,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param structure_id [Integer,String] Return orders in this structure
+      # @param structure_id [Integer] Return orders in this structure
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -293,7 +293,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Market/get_markets_structures_structure_id
-      def get_markets_structure(structure_id:, params: {}, headers: {})
+      def get_markets_structure(structure_id:, headers: {}, params: {})
         get("/markets/structures/#{structure_id}/", headers: headers, params: params)
       end
       alias get_markets_structures_structure_id get_markets_structure

data/lib/esi/client/opportunities.rb

@@ -16,7 +16,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -29,7 +29,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Opportunities/get_characters_character_id_opportunities
-      def get_character_opportunities(character_id:, params: {}, headers: {})
+      def get_character_opportunities(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/opportunities/", headers: headers, params: params)
       end
       alias get_characters_character_id_opportunities get_character_opportunities
@@ -40,7 +40,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param group_id [Integer,String] ID of an opportunities group
+      # @param group_id [Integer] ID of an opportunities group
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -51,7 +51,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_groups_group_id
-      def get_opportunities_group(group_id:, params: {}, headers: {})
+      def get_opportunities_group(group_id:, headers: {}, params: {})
         get("/opportunities/groups/#{group_id}/", headers: headers, params: params)
       end
       alias get_opportunities_groups_group_id get_opportunities_group
@@ -62,7 +62,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param task_id [Integer,String] ID of an opportunities task
+      # @param task_id [Integer] ID of an opportunities task
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -73,7 +73,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_tasks_task_id
-      def get_opportunities_task(task_id:, params: {}, headers: {})
+      def get_opportunities_task(task_id:, headers: {}, params: {})
         get("/opportunities/tasks/#{task_id}/", headers: headers, params: params)
       end
       alias get_opportunities_tasks_task_id get_opportunities_task
@@ -94,7 +94,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_groups
-      def get_opportunity_groups(params: {}, headers: {})
+      def get_opportunity_groups(headers: {}, params: {})
         get("/opportunities/groups/", headers: headers, params: params)
       end
       alias get_opportunities_groups get_opportunity_groups
@@ -115,7 +115,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Opportunities/get_opportunities_tasks
-      def get_opportunity_tasks(params: {}, headers: {})
+      def get_opportunity_tasks(headers: {}, params: {})
         get("/opportunities/tasks/", headers: headers, params: params)
       end
       alias get_opportunities_tasks get_opportunity_tasks

data/lib/esi/client/planetary_interaction.rb

@@ -13,8 +13,8 @@ module ESI
       # @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 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
       #
@@ -28,7 +28,7 @@ module ESI
       # @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: {})
+      def get_character_planet(character_id:, planet_id:, headers: {}, params: {})
         get("/characters/#{character_id}/planets/#{planet_id}/", headers: headers, params: params)
       end
       alias get_characters_character_id_planets_planet_id get_character_planet
@@ -45,7 +45,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -58,7 +58,7 @@ module ESI
       # @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: {})
+      def get_character_planets(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/planets/", headers: headers, params: params)
       end
       alias get_characters_character_id_planets get_character_planets
@@ -75,7 +75,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param corporation_id [Integer] An EVE corporation ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -88,7 +88,7 @@ module ESI
       # @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: {})
+      def get_corporation_customs_offices(corporation_id:, headers: {}, params: {})
         get("/corporations/#{corporation_id}/customs_offices/", headers: headers, params: params)
       end
       alias get_corporations_corporation_id_customs_offices get_corporation_customs_offices
@@ -101,7 +101,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param schematic_id [Integer,String] A PI schematic ID
+      # @param schematic_id [Integer] A PI schematic ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -113,7 +113,7 @@ module ESI
       # @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: {})
+      def get_universe_schematic(schematic_id:, headers: {}, params: {})
         get("/universe/schematics/#{schematic_id}/", headers: headers, params: params)
       end
       alias get_universe_schematics_schematic_id get_universe_schematic

data/lib/esi/client/routes.rb

@@ -12,11 +12,11 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param destination [Integer,String] destination solar system ID
-      # @param origin [Integer,String] origin solar system ID
+      # @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
+      # @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
       #
@@ -28,9 +28,9 @@ module ESI
       # @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)
+      def get_route_origin_destination(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)
       end
     end
   end

data/lib/esi/client/search.rb

@@ -16,7 +16,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v3
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @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
@@ -32,9 +32,9 @@ module ESI
       # @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)
+      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)
       end
       alias get_characters_character_id_search get_character_search
 
@@ -59,9 +59,9 @@ module ESI
       # @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)
+      def get_search(categories:, search:, strict: nil, headers: {}, params: {})
+        params.merge!("categories" => categories, "search" => search, "strict" => strict)
+        get("/search/", headers: headers, params: params)
       end
     end
   end

data/lib/esi/client/skills.rb

@@ -16,7 +16,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -29,7 +29,7 @@ module ESI
       # @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: {})
+      def get_character_attributes(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/attributes/", headers: headers, params: params)
       end
       alias get_characters_character_id_attributes get_character_attributes
@@ -46,7 +46,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v2
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -59,7 +59,7 @@ module ESI
       # @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: {})
+      def get_character_skillqueue(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/skillqueue/", headers: headers, params: params)
       end
       alias get_characters_character_id_skillqueue get_character_skillqueue
@@ -75,7 +75,7 @@ module ESI
       # @esi_version dev
       # @esi_version v4
       #
-      # @param character_id [Integer,String] An EVE character ID
+      # @param character_id [Integer] An EVE character ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -88,7 +88,7 @@ module ESI
       # @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: {})
+      def get_character_skills(character_id:, headers: {}, params: {})
         get("/characters/#{character_id}/skills/", headers: headers, params: params)
       end
       alias get_characters_character_id_skills get_character_skills

data/lib/esi/client/sovereignty.rb

@@ -22,7 +22,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_campaigns
-      def get_sovereignty_campaigns(params: {}, headers: {})
+      def get_sovereignty_campaigns(headers: {}, params: {})
         get("/sovereignty/campaigns/", headers: headers, params: params)
       end
 
@@ -44,7 +44,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_map
-      def get_sovereignty_map(params: {}, headers: {})
+      def get_sovereignty_map(headers: {}, params: {})
         get("/sovereignty/map/", headers: headers, params: params)
       end
 
@@ -66,7 +66,7 @@ module ESI
       # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
       #
       # @see https://esi.evetech.net/ui/#/Sovereignty/get_sovereignty_structures
-      def get_sovereignty_structures(params: {}, headers: {})
+      def get_sovereignty_structures(headers: {}, params: {})
         get("/sovereignty/structures/", headers: headers, params: params)
       end
     end