docs/UniverseApi.md in esi_client-1.2.0 vs docs/UniverseApi.md in esi_client-1.3.0

- old
+ new

@@ -1,8 +1,8 @@ # ESIClient::UniverseApi -All URIs are relative to *https://esi.tech.ccp.is/* +All URIs are relative to *https://esi.tech.ccp.is* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_universe_bloodlines**](UniverseApi.md#get_universe_bloodlines) | **GET** /v1/universe/bloodlines/ | Get bloodlines [**get_universe_categories**](UniverseApi.md#get_universe_categories) | **GET** /v1/universe/categories/ | Get item categories @@ -18,19 +18,20 @@ [**get_universe_planets_planet_id**](UniverseApi.md#get_universe_planets_planet_id) | **GET** /v1/universe/planets/{planet_id}/ | Get planet information [**get_universe_races**](UniverseApi.md#get_universe_races) | **GET** /v1/universe/races/ | Get character races [**get_universe_regions**](UniverseApi.md#get_universe_regions) | **GET** /v1/universe/regions/ | Get regions [**get_universe_regions_region_id**](UniverseApi.md#get_universe_regions_region_id) | **GET** /v1/universe/regions/{region_id}/ | Get region information [**get_universe_stargates_stargate_id**](UniverseApi.md#get_universe_stargates_stargate_id) | **GET** /v1/universe/stargates/{stargate_id}/ | Get stargate information +[**get_universe_stars_star_id**](UniverseApi.md#get_universe_stars_star_id) | **GET** /v1/universe/stars/{star_id}/ | Get star information [**get_universe_stations_station_id**](UniverseApi.md#get_universe_stations_station_id) | **GET** /v2/universe/stations/{station_id}/ | Get station information [**get_universe_structures**](UniverseApi.md#get_universe_structures) | **GET** /v1/universe/structures/ | List all public structures [**get_universe_structures_structure_id**](UniverseApi.md#get_universe_structures_structure_id) | **GET** /v1/universe/structures/{structure_id}/ | Get structure information [**get_universe_system_jumps**](UniverseApi.md#get_universe_system_jumps) | **GET** /v1/universe/system_jumps/ | Get system jumps -[**get_universe_system_kills**](UniverseApi.md#get_universe_system_kills) | **GET** /v1/universe/system_kills/ | Get system kills +[**get_universe_system_kills**](UniverseApi.md#get_universe_system_kills) | **GET** /v2/universe/system_kills/ | Get system kills [**get_universe_systems**](UniverseApi.md#get_universe_systems) | **GET** /v1/universe/systems/ | Get solar systems -[**get_universe_systems_system_id**](UniverseApi.md#get_universe_systems_system_id) | **GET** /v2/universe/systems/{system_id}/ | Get solar system information +[**get_universe_systems_system_id**](UniverseApi.md#get_universe_systems_system_id) | **GET** /v3/universe/systems/{system_id}/ | Get solar system information [**get_universe_types**](UniverseApi.md#get_universe_types) | **GET** /v1/universe/types/ | Get types -[**get_universe_types_type_id**](UniverseApi.md#get_universe_types_type_id) | **GET** /v2/universe/types/{type_id}/ | Get type information +[**get_universe_types_type_id**](UniverseApi.md#get_universe_types_type_id) | **GET** /v3/universe/types/{type_id}/ | Get type information [**post_universe_names**](UniverseApi.md#post_universe_names) | **POST** /v2/universe/names/ | Get names and categories for a set of ID's # **get_universe_bloodlines** > Array<GetUniverseBloodlines200Ok> get_universe_bloodlines(opts) @@ -479,11 +480,11 @@ api_instance = ESIClient::UniverseApi.new opts = { datasource: "tranquility", # String | The server name you would like data from - page: 56, # Integer | Which page to query + page: 1, # Integer | Which page of results to return user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent } begin @@ -498,11 +499,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **page** | **Integer**| Which page to query | [optional] + **page** | **Integer**| Which page of results to return | [optional] [default to 1] **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] ### Return type @@ -902,10 +903,65 @@ - **Content-Type**: Not defined - **Accept**: application/json +# **get_universe_stars_star_id** +> GetUniverseStarsStarIdOk get_universe_stars_star_id(star_id, opts) + +Get star information + +Get information on a star --- This route expires daily at 11:05 + +### Example +```ruby +# load the gem +require 'esi_client' + +api_instance = ESIClient::UniverseApi.new + +star_id = 56 # Integer | star_id integer + +opts = { + datasource: "tranquility", # String | The server name you would like data from + user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers + x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent +} + +begin + #Get star information + result = api_instance.get_universe_stars_star_id(star_id, opts) + p result +rescue ESIClient::ApiError => e + puts "Exception when calling UniverseApi->get_universe_stars_star_id: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **star_id** | **Integer**| star_id integer | + **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] + **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] + **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] + +### Return type + +[**GetUniverseStarsStarIdOk**](GetUniverseStarsStarIdOk.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + + # **get_universe_stations_station_id** > GetUniverseStationsStationIdOk get_universe_stations_station_id(station_id, opts) Get station information @@ -1032,11 +1088,11 @@ structure_id = 789 # Integer | An Eve structure ID opts = { datasource: "tranquility", # String | The server name you would like data from - token: "token_example", # String | Access token to use, if preferred over a header + token: "token_example", # String | Access token to use if unable to set a header user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent } begin @@ -1052,11 +1108,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **structure_id** | **Integer**| An Eve structure ID | **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **token** | **String**| Access token to use, if preferred over a header | [optional] + **token** | **String**| Access token to use if unable to set a header | [optional] **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] ### Return type @@ -1300,11 +1356,11 @@ api_instance = ESIClient::UniverseApi.new opts = { datasource: "tranquility", # String | The server name you would like data from - page: 56, # Integer | Which page to query + page: 1, # Integer | Which page of results to return user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent } begin @@ -1319,10 +1375,10 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **datasource** | **String**| The server name you would like data from | [optional] [default to tranquility] - **page** | **Integer**| Which page to query | [optional] + **page** | **Integer**| Which page of results to return | [optional] [default to 1] **user_agent** | **String**| Client identifier, takes precedence over headers | [optional] **x_user_agent** | **String**| Client identifier, takes precedence over User-Agent | [optional] ### Return type